policyengine 5.3.0__tar.gz → 5.3.1__tar.gz

{policyengine-5.3.0 → policyengine-5.3.1}/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [5.3.1] - 2026-09-10
+
+### Fixed
+
+- Pin the compatible SPM calculator in US model extras and bundle installation requirements while preserving the certified model and dataset versions.
+
+
 ## [5.3.0] - 2026-08-30
 
 ### Added

{policyengine-5.3.0 → policyengine-5.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 5.3.0
+Version: 5.3.1
 Summary: A package to conduct policy analysis using PolicyEngine tax-benefit models.
 Author-email: PolicyEngine <hello@policyengine.org>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -690,12 +690,14 @@ Provides-Extra: models
 Requires-Dist: policyengine-core==3.30.1; extra == "models"
 Requires-Dist: policyengine-us==1.764.6; extra == "models"
 Requires-Dist: policyengine-uk==2.90.2; extra == "models"
+Requires-Dist: spm-calculator==0.3.1; extra == "models"
 Provides-Extra: uk
 Requires-Dist: policyengine-core==3.30.1; extra == "uk"
 Requires-Dist: policyengine-uk==2.90.2; extra == "uk"
 Provides-Extra: us
 Requires-Dist: policyengine-core==3.30.1; extra == "us"
 Requires-Dist: policyengine-us==1.764.6; extra == "us"
+Requires-Dist: spm-calculator==0.3.1; extra == "us"
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: furo; extra == "dev"
@@ -713,6 +715,7 @@ Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
 Requires-Dist: policyengine-core==3.30.1; extra == "dev"
 Requires-Dist: policyengine-us==1.764.6; extra == "dev"
 Requires-Dist: policyengine-uk==2.90.2; extra == "dev"
+Requires-Dist: spm-calculator==0.3.1; extra == "dev"
 Dynamic: license-file
 
 # PolicyEngine.py

{policyengine-5.3.0 → policyengine-5.3.1}/docs/bundles.md

@@ -84,6 +84,19 @@ Derived artifacts are:
 - `src/policyengine/data/bundle/{country}.trace.tro.jsonld`
 - GitHub release assets exported from the bundle manifest
 
+The US model in this bundle uses the SPM calculator 0.3.1 API. The manifest pins
+`spm-calculator==0.3.1` in the US package scaffold and the generated `us`,
+`models`, and `dev` extras. The model formulas and certified dataset artifacts
+remain unchanged.
+
+Previously published versions cannot acquire a new dependency constraint. To
+reproduce the historical 5.3.0 US package set, include the compatible calculator
+explicitly:
+
+```bash
+uv pip install "policyengine[us]==5.3.0" "spm-calculator==0.3.1"
+```
+
 Inspect or verify a local setup with:
 
 ```bash

{policyengine-5.3.0 → policyengine-5.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "policyengine"
-version = "5.3.0"
+version = "5.3.1"
 description = "A package to conduct policy analysis using PolicyEngine tax-benefit models."
 readme = "README.md"
 authors = [
@@ -45,6 +45,7 @@ models = [
     "policyengine-core==3.30.1",
     "policyengine-us==1.764.6",
     "policyengine-uk==2.90.2",
+    "spm-calculator==0.3.1",
 ]
 uk = [
     "policyengine-core==3.30.1",
@@ -53,6 +54,7 @@ uk = [
 us = [
     "policyengine-core==3.30.1",
     "policyengine-us==1.764.6",
+    "spm-calculator==0.3.1",
 ]
 dev = [
     "pytest",
@@ -71,6 +73,7 @@ dev = [
     "policyengine-core==3.30.1",
     "policyengine-us==1.764.6",
     "policyengine-uk==2.90.2",
+    "spm-calculator==0.3.1",
 ]
 
 [tool.setuptools]

{policyengine-5.3.0 → policyengine-5.3.1}/src/policyengine/data/bundle/manifest.json

@@ -1,10 +1,10 @@
 {
-  "bundle_version": "5.3.0",
+  "bundle_version": "5.3.1",
   "citation": {
     "publisher": "PolicyEngine",
-    "title": "PolicyEngine bundle 5.3.0",
+    "title": "PolicyEngine bundle 5.3.1",
     "type": "software-bundle",
-    "version": "5.3.0"
+    "version": "5.3.1"
   },
   "countries": {
     "uk": {
@@ -17,7 +17,7 @@
   "data_releases": {
     "uk": {
       "build_id": "policyengine-uk-data-1.56.16",
-      "bundle_id": "uk-5.3.0",
+      "bundle_id": "uk-5.3.1",
       "certification": {
         "built_with_model_git_sha": "12a1e028afeef08d8b2d74ee03fd9de3a78b2dd3",
         "built_with_model_version": "2.89.2",
@@ -99,7 +99,7 @@
         "version": "2.90.2",
         "wheel_url": "https://files.pythonhosted.org/packages/ec/da/658bff2df6094bd7bf2b0f561ff60fd41508adbd0a3af29b4553c83bc678/policyengine_uk-2.90.2-py3-none-any.whl"
       },
-      "policyengine_version": "5.3.0",
+      "policyengine_version": "5.3.1",
       "region_datasets": {
         "national": {
           "path_template": "enhanced_frs_2024_25.h5"
@@ -112,7 +112,7 @@
     },
     "us": {
       "build_id": "populace-us-2024-buildp-sparse-rmloss100-cae8640-20260728T011454Z",
-      "bundle_id": "us-5.3.0",
+      "bundle_id": "us-5.3.1",
       "certification": {
         "built_with_model_version": "1.764.6",
         "certified_by": "policyengine.py bundle certification",
@@ -186,7 +186,7 @@
         "version": "1.764.6",
         "wheel_url": "https://files.pythonhosted.org/packages/e2/5a/0566666f30ad06e416f0cf25b24bdee73acd71897fb2de3c0ac43b59e3e3/policyengine_us-1.764.6-py3-none-any.whl"
       },
-      "policyengine_version": "5.3.0",
+      "policyengine_version": "5.3.1",
       "region_datasets": {
         "national": {
           "path_template": "populace_us_2024.h5"
@@ -240,7 +240,8 @@
     "models": [
       "policyengine-core",
       "policyengine-us",
-      "policyengine-uk"
+      "policyengine-uk",
+      "spm-calculator"
     ],
     "uk": [
       "policyengine-core",
@@ -248,16 +249,17 @@
     ],
     "us": [
       "policyengine-core",
-      "policyengine-us"
+      "policyengine-us",
+      "spm-calculator"
     ]
   },
   "packages": {
     "policyengine": {
       "import_name": "policyengine",
-      "install_requirement": "policyengine==5.3.0",
+      "install_requirement": "policyengine==5.3.1",
       "name": "policyengine",
       "role": "bundle_carrier",
-      "version": "5.3.0"
+      "version": "5.3.1"
     },
     "policyengine-core": {
       "import_name": "policyengine_core",
@@ -281,8 +283,16 @@
       "name": "policyengine-us",
       "role": "country_model",
       "version": "1.764.6"
+    },
+    "spm-calculator": {
+      "country": "us",
+      "import_name": "spm_calculator",
+      "install_requirement": "spm-calculator==0.3.1",
+      "name": "spm-calculator",
+      "role": "country_dependency",
+      "version": "0.3.1"
     }
   },
-  "policyengine_version": "5.3.0",
+  "policyengine_version": "5.3.1",
   "schema_version": 2
 }

{policyengine-5.3.0 → policyengine-5.3.1}/src/policyengine/data/bundle/uk.trace.tro.jsonld

@@ -18,18 +18,18 @@
         "schema:url": "https://policyengine.org"
       },
       "schema:dateCreated": "2026-08-18T14:20:32.100961Z",
-      "schema:description": "TRACE TRO for certified runtime bundle uk-5.3.0 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
+      "schema:description": "TRACE TRO for certified runtime bundle uk-5.3.1 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
       "schema:name": "policyengine uk certified bundle TRO",
       "trov:createdWith": {
         "@type": "schema:SoftwareApplication",
         "schema:name": "policyengine",
-        "schema:softwareVersion": "5.3.0"
+        "schema:softwareVersion": "5.3.1"
       },
       "trov:hasArrangement": [
         {
           "@id": "arrangement/1",
           "@type": "trov:ArtifactArrangement",
-          "rdfs:comment": "Certified arrangement for bundle uk-5.3.0.",
+          "rdfs:comment": "Certified arrangement for bundle uk-5.3.1.",
           "trov:hasArtifactLocation": [
             {
               "@id": "arrangement/1/location/bundle_manifest",
@@ -75,7 +75,7 @@
             "@type": "trov:ResearchArtifact",
             "schema:name": "policyengine.py bundle manifest for uk",
             "trov:mimeType": "application/json",
-            "trov:sha256": "57c6fe9c5c370ea2b9460120656004b1a583db06cabb6c774551effc3c125695"
+            "trov:sha256": "75a9dab38c12dd00051f363532f2f45315557fecaf41d5827615bac4180de358"
           },
           {
             "@id": "composition/1/artifact/data_release_manifest",
@@ -102,7 +102,7 @@
         "trov:hasFingerprint": {
           "@id": "composition/1/fingerprint",
           "@type": "trov:CompositionFingerprint",
-          "trov:sha256": "90a113dd7e642af4c137af233b512fa7ff68b5ba0aa9b4102b7dd02bd8fe5cbf"
+          "trov:sha256": "0f664a8f0d9a4adaff2b7a04cac2dcb9d813770e395b6d77170a8078360e3733"
         }
       },
       "trov:hasPerformance": {

{policyengine-5.3.0 → policyengine-5.3.1}/src/policyengine/data/bundle/us.trace.tro.jsonld

@@ -18,18 +18,18 @@
         "schema:url": "https://policyengine.org"
       },
       "schema:dateCreated": "2026-07-28T03:56:03.415544+00:00",
-      "schema:description": "TRACE TRO for certified runtime bundle us-5.3.0 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
+      "schema:description": "TRACE TRO for certified runtime bundle us-5.3.1 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
       "schema:name": "policyengine us certified bundle TRO",
       "trov:createdWith": {
         "@type": "schema:SoftwareApplication",
         "schema:name": "policyengine",
-        "schema:softwareVersion": "5.3.0"
+        "schema:softwareVersion": "5.3.1"
       },
       "trov:hasArrangement": [
         {
           "@id": "arrangement/1",
           "@type": "trov:ArtifactArrangement",
-          "rdfs:comment": "Certified arrangement for bundle us-5.3.0.",
+          "rdfs:comment": "Certified arrangement for bundle us-5.3.1.",
           "trov:hasArtifactLocation": [
             {
               "@id": "arrangement/1/location/bundle_manifest",
@@ -75,7 +75,7 @@
             "@type": "trov:ResearchArtifact",
             "schema:name": "policyengine.py bundle manifest for us",
             "trov:mimeType": "application/json",
-            "trov:sha256": "57c6fe9c5c370ea2b9460120656004b1a583db06cabb6c774551effc3c125695"
+            "trov:sha256": "75a9dab38c12dd00051f363532f2f45315557fecaf41d5827615bac4180de358"
           },
           {
             "@id": "composition/1/artifact/data_release_manifest",
@@ -102,7 +102,7 @@
         "trov:hasFingerprint": {
           "@id": "composition/1/fingerprint",
           "@type": "trov:CompositionFingerprint",
-          "trov:sha256": "c9806c4dbc8cb664ca2ed431af72f8540c08171fea5ce02d6e579f2d6866cf21"
+          "trov:sha256": "1a3131f53ec77aa7eebf243f01bff2969848e8979dc40d23d94f28dff03aa5de"
         }
       },
       "trov:hasPerformance": {

{policyengine-5.3.0 → policyengine-5.3.1}/src/policyengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 5.3.0
+Version: 5.3.1
 Summary: A package to conduct policy analysis using PolicyEngine tax-benefit models.
 Author-email: PolicyEngine <hello@policyengine.org>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -690,12 +690,14 @@ Provides-Extra: models
 Requires-Dist: policyengine-core==3.30.1; extra == "models"
 Requires-Dist: policyengine-us==1.764.6; extra == "models"
 Requires-Dist: policyengine-uk==2.90.2; extra == "models"
+Requires-Dist: spm-calculator==0.3.1; extra == "models"
 Provides-Extra: uk
 Requires-Dist: policyengine-core==3.30.1; extra == "uk"
 Requires-Dist: policyengine-uk==2.90.2; extra == "uk"
 Provides-Extra: us
 Requires-Dist: policyengine-core==3.30.1; extra == "us"
 Requires-Dist: policyengine-us==1.764.6; extra == "us"
+Requires-Dist: spm-calculator==0.3.1; extra == "us"
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: furo; extra == "dev"
@@ -713,6 +715,7 @@ Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
 Requires-Dist: policyengine-core==3.30.1; extra == "dev"
 Requires-Dist: policyengine-us==1.764.6; extra == "dev"
 Requires-Dist: policyengine-uk==2.90.2; extra == "dev"
+Requires-Dist: spm-calculator==0.3.1; extra == "dev"
 Dynamic: license-file
 
 # PolicyEngine.py

{policyengine-5.3.0 → policyengine-5.3.1}/src/policyengine.egg-info/requires.txt

@@ -24,6 +24,7 @@ pytest-cov>=5.0.0
 policyengine-core==3.30.1
 policyengine-us==1.764.6
 policyengine-uk==2.90.2
+spm-calculator==0.3.1
 
 [graph]
 networkx>=3.0
@@ -32,6 +33,7 @@ networkx>=3.0
 policyengine-core==3.30.1
 policyengine-us==1.764.6
 policyengine-uk==2.90.2
+spm-calculator==0.3.1
 
 [plotting]
 plotly>=5.0.0
@@ -43,3 +45,4 @@ policyengine-uk==2.90.2
 [us]
 policyengine-core==3.30.1
 policyengine-us==1.764.6
+spm-calculator==0.3.1

{policyengine-5.3.0 → policyengine-5.3.1}/tests/test_bundle.py

@@ -64,6 +64,7 @@ def test_bundle_install_requirements_are_country_scoped():
         f"policyengine=={manifest['policyengine_version']}",
         manifest["packages"]["policyengine-core"]["install_requirement"],
         manifest["packages"]["policyengine-us"]["install_requirement"],
+        "spm-calculator==0.3.1",
     ]
     assert not any("policyengine-us-data" in req for req in us_requirements)
 

{policyengine-5.3.0 → policyengine-5.3.1}/tests/test_bundle_metadata.py

@@ -29,10 +29,12 @@ def test_bundle_manifest_exposes_model_and_country_extras():
         "policyengine-core",
         "policyengine-us",
         "policyengine-uk",
+        "spm-calculator",
     ]
     assert manifest["extras"]["us"] == [
         "policyengine-core",
         "policyengine-us",
+        "spm-calculator",
     ]
     assert manifest["extras"]["uk"] == [
         "policyengine-core",
@@ -42,6 +44,24 @@ def test_bundle_manifest_exposes_model_and_country_extras():
     assert "policyengine-us-data" not in manifest["packages"]
 
 
+def test_generated_us_extras_preserve_legacy_spm_compatibility(monkeypatch):
+    scripts_dir = Path(__file__).resolve().parents[1] / "scripts"
+    monkeypatch.syspath_prepend(str(scripts_dir))
+    from generate_bundle_artifacts import update_pyproject_text
+
+    pyproject_path = scripts_dir.parent / "pyproject.toml"
+    original = pyproject_path.read_text()
+    generated = update_pyproject_text(original, bundle.get_current_bundle())
+    # Regeneration and a later release must retain the constraint in every US
+    # installation surface, including dev; the UK-only extra does not need it.
+    assert generated == original
+    for extra in ("us", "models", "dev"):
+        section = generated.split(f"\n{extra} = [\n", 1)[1].split("\n]", 1)[0]
+        assert '"spm-calculator==0.3.1"' in section
+    uk_section = generated.split("\nuk = [\n", 1)[1].split("\n]", 1)[0]
+    assert "spm-calculator" not in uk_section
+
+
 def test_bundle_manifest_carries_uk_data_release():
     release = bundle.get_current_bundle()["data_releases"]["uk"]
 
@@ -115,6 +135,10 @@ def test_export_release_assets_writes_bundle_assets(monkeypatch, tmp_path):
         f"policyengine=={manifest['policyengine_version']}"
         in (tmp_path / f"policyengine-bundle-{version}.constraints.txt").read_text()
     )
+    assert (
+        "spm-calculator==0.3.1"
+        in (tmp_path / f"policyengine-bundle-{version}.constraints.txt").read_text()
+    )
     assert (
         "PolicyEngine bundle"
         in (tmp_path / f"policyengine-bundle-{version}.citation.txt").read_text()