Feature/53 odds and ends

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.8.2
+current_version = 0.8.3
 commit = True
 tag = True
 

CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.3] - 2024-10-09
+
+### Changed
+ - name of function in `nzshm_common.location` from `_lat_lon` to `lat_lon_by_id`
+ - import `location.location` functions into base package init for ease of use
+
+### Fixed
+ - docstring for function `nzshm_common.location.location_by_id`
+
 ## [0.8.2] - 2024-09-21
 ### Added
  - within_polygon helper function

nzshm_common/__init__.py

@@ -1,6 +1,6 @@
 __author__ = "GNS Science"
 __email__ = '[email protected]'
-__version__ = '0.8.2'
+__version__ = '0.8.3'
 
 from .location import location
 

nzshm_common/location/__init__.py

@@ -1 +1,2 @@
 from .coded_location import CodedLocation, CodedLocationBin
+from .location import get_location_list, get_location_list_names, get_locations, lat_lon_by_id, location_by_id

nzshm_common/location/location.py

@@ -63,7 +63,7 @@
 }
 
 
-def _lat_lon(_id) -> Optional[LatLon]:
+def lat_lon_by_id(_id) -> Optional[LatLon]:
     loc = location_by_id(_id)
     if loc:
         return LatLon(loc['latitude'], loc['longitude'])
@@ -83,7 +83,7 @@ def _load_csv(locations_filepath, resolution):
 
 def location_by_id(location_code: str) -> Optional[Dict[str, Any]]:
     """
-    Get the CodedLocation for a location identified by an id.
+    Get the information for a location identified by an id.
 
     Parameters:
         location_code: the code (e.g. "WLG") for the location
@@ -125,10 +125,10 @@ def get_locations(locations: Iterable[str], resolution: float = DEFAULT_RESOLUTI
             lat, lon = location_id.split('~')
             coded_locations.append(CodedLocation(float(lat), float(lon), resolution))
         elif location_by_id(location_id):
-            coded_locations.append(CodedLocation(*_lat_lon(location_id), resolution))  # type: ignore
+            coded_locations.append(CodedLocation(*lat_lon_by_id(location_id), resolution))  # type: ignore
         elif LOCATION_LISTS.get(location_id):
             location_ids = LOCATION_LISTS[location_id]["locations"]
-            coded_locations += [CodedLocation(*_lat_lon(_id), resolution) for _id in location_ids]  # type: ignore
+            coded_locations += [CodedLocation(*lat_lon_by_id(_id), resolution) for _id in location_ids]  # type: ignore
         else:
             try:
                 coded_locations += [CodedLocation(*loc, resolution) for loc in load_grid(location_id)]  # type: ignore

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nzshm-common"
-version = "0.8.2"
+version = "0.8.3"
 homepage = "https://github.com/GNS-Science/nzshm-common-py"
 description = "A small pure python library for shared NZ NSHM data like locations."
 authors = ["GNS Science <[email protected]>"]

tests/test_location.py

@@ -53,4 +53,4 @@ def get_lat_lon(id):
 
 
 def test_missing_lat_lon_returns_None():
-    assert location._lat_lon("missingid") is None, "An unknown ID should return a None"
+    assert location.lat_lon_by_id("missingid") is None, "An unknown ID should return a None"