PolicyEngine Core
A fork of OpenFisca-Core that powers PolicyEngine country models (policyengine-uk, policyengine-us, policyengine-canada, policyengine-il, policyengine-ng) and the downstream apps and APIs. Provides the simulation engine, parameter tree, variable system, and reform machinery that each country package builds on top of.
Install
pip install policyengine-core
Supports Python 3.11–3.14.
Usage
Most users reach this package transitively through a country model. Import directly if you're building a new country model, writing a reform, or extending the core:
from policyengine_core.simulations import Simulation
from policyengine_core.reforms import Reform
See the documentation for API reference and tutorials.
Development
# Install dev dependencies (uses uv)
make install
# Run the full test suite
make test
# Run a single test
uv run pytest tests/core/test_file.py::test_name -v
# Format before committing (CI enforces)
make format
# Lint GitHub Actions workflows after editing .github/, from the repo root
# (CI enforces; install shellcheck and pyflakes so actionlint also checks
# run: scripts)
uvx --from actionlint-py==1.7.12.25 actionlint
Always use uv run for Python commands; bare python / pytest / pip may pick up the wrong environment.
Contributions: see CONTRIBUTING.md for branching, PR conventions, and the towncrier changelog.d/ workflow. Default branch is master.
License
Distributed under the AGPL License. See LICENSE for details.
Acknowledgements
- Forked from OpenFisca-Core.
- README template adapted from Othneil Drew's Best-README-Template.
1 maintainer
Metadata
1 maintainer
Release files for policyengine-core 3.33.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| policyengine_core-3.33.4.tar.gz | 693.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| policyengine_core-3.33.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 995.2 kB
Release files / policyengine_core-3.33.4.tar.gz
| Download URL | policyengine_core-3.33.4.tar.gz |
|---|---|
| Size | 693.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
becfb83ad01aec49e899f9bc5b4023bc1a0488fd278b4f2e9c59c9a10d18dc97
|
|
BLAKE2b-256 checksum How to use checksums |
57ec326217ca04ed426a222d1e03385e53e1cd3f8b96a4411b34753c8a5ebea6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / policyengine_core-3.33.4-py3-none-any.whl
| Download URL | policyengine_core-3.33.4-py3-none-any.whl |
|---|---|
| Size | 301.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7fcc0a9839a5ea0ae5c4abac28207fb1ab9cce7619a64409162337d95a3103fc
|
|
BLAKE2b-256 checksum How to use checksums |
85707328bbe2c4eb78c134598ab2de2376d8a5417277909a88a83673eca06fe8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency log
