Feature/53 odds and ends

[chrisdicaprio]

closes #53

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.99%. Comparing base (01cc52f) to head (006a116).
Report is 7 commits behind head on pre-release.

Additional details and impacted files

@@             Coverage Diff              @@
##           pre-release      #54   +/-   ##
============================================
  Coverage        97.99%   97.99%           
============================================
  Files               17       17           
  Lines              299      299           
  Branches            51       47    -4     
============================================
  Hits               293      293           
- Misses               2        3    +1     
+ Partials             4        3    -1     

Flag	Coverage Δ
unittests	97.99% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[chrisbc]

@chrisdicaprio this PR raised a few questions for me are we elevating more than we need to?? ... recall the work the Zoey / David did on the location_by_id function.

Maybe putting the some example docstrings to show how they're meant to be used will clarify this.

[chrisdicaprio]

I have removed an import from the top level __init__.py:

from .location import location

and added an import of useful functions to the location/init.py

from .location import get_location_list, get_location_list_names, get_locations, location_by_id

This allows the user to do:

>>> from nzshm_common.location import location_by_id

but no longer allows

>>> from nzshm_common import location
>>> location.LOCATION_LISTS

The intent is to elevate the user API to the nzshm_common.location package and hide attributes of nzshm_common.location.location that the users is meant to access via helper functions rather than directly.

[chrisbc]

Thanks @chrisdicaprio, looks great