From c92fe32e782bf825952a8d1c8a270e0e2b974767 Mon Sep 17 00:00:00 2001
From: jgunstone <j.gunstone@maxfordham.com>
Date: Mon, 10 Nov 2025 16:42:22 +0000
Subject: [PATCH 1/2] update api

---
 README.md                                      | 10 +++++++++-
 src/netzero_metrics_reference_data/__init__.py |  5 +++--
 2 files changed, 12 insertions(+), 3 deletions(-)

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..510ce18 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():
+    return Package(PTH_PKG)

From ee999bdd0e54ef9087da1878348cd84175eaf6d8 Mon Sep 17 00:00:00 2001
From: jgunstone <j.gunstone@maxfordham.com>
Date: Mon, 10 Nov 2025 16:45:29 +0000
Subject: [PATCH 2/2] fix tests

---
 src/netzero_metrics_reference_data/__init__.py | 2 +-
 tests/test_netzero_metrics_reference_data.py   | 5 ++++-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/netzero_metrics_reference_data/__init__.py b/src/netzero_metrics_reference_data/__init__.py
index 510ce18..d5b6faf 100644
--- a/src/netzero_metrics_reference_data/__init__.py
+++ b/src/netzero_metrics_reference_data/__init__.py
@@ -8,5 +8,5 @@
 )
 
 
-def load_datapackage():
+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",