diff --git a/README.md b/README.md index f4be4a0..8239dde 100644 --- a/README.md +++ b/README.md @@ -17,5 +17,13 @@ It has also been packaged as a Python package to enable easy, version-controlled pip install netzero-metrics-reference-data ``` +**Usage** + +```python +import netzero_metrics_reference_data as nz_data + +data = nz_data.load_datapackage() +``` + > [!NOTE] -> The data in the root of the repo is active and up-to-date. The data in the src directory is overwritten by the root data when the pacakge is built. +> The data in the root of the repo is active and up-to-date. The data in the src directory is overwritten by the root data when the package is built. diff --git a/src/netzero_metrics_reference_data/__init__.py b/src/netzero_metrics_reference_data/__init__.py index 73995a3..d5b6faf 100644 --- a/src/netzero_metrics_reference_data/__init__.py +++ b/src/netzero_metrics_reference_data/__init__.py @@ -6,6 +6,7 @@ .joinpath("data") .joinpath("datapackage.yaml") ) -nzm_pkg = Package(PTH_PKG) -__all__ = ["nzm_pkg"] + +def load_datapackage() -> Package: + return Package(PTH_PKG) diff --git a/tests/test_netzero_metrics_reference_data.py b/tests/test_netzero_metrics_reference_data.py index 794810e..a2f5c4a 100644 --- a/tests/test_netzero_metrics_reference_data.py +++ b/tests/test_netzero_metrics_reference_data.py @@ -1,7 +1,10 @@ -from netzero_metrics_reference_data import nzm_pkg +from netzero_metrics_reference_data import load_datapackage +from frictionless import Package def test_nzm_pkg(): + nzm_pkg = load_datapackage() + assert isinstance(nzm_pkg, Package) assert nzm_pkg is not None li = [ "energy-use-intensity",