Skip to main content

PolicyEngine Core

codecov PyPI version Ruff

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

Metadata

Release files for policyengine-core 3.36.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for policyengine-core 3.36.1
File Size Uploaded Provenance Actions
policyengine_core-3.36.1.tar.gz 819.6 kB With provenance Details for policyengine_core-3.36.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for policyengine-core 3.36.1
File Interpreter ABI Platform Actions
policyengine_core-3.36.1-py3-none-any.whl Python 3 none any Details for policyengine_core-3.36.1-py3-none-any.whl

Total release size: 1.1 MB

Release files / policyengine_core-3.36.1.tar.gz

Download URL policyengine_core-3.36.1.tar.gz
Size 819.6 kB
Tags Source
SHA-256 checksum
How to use checksums
c428835fc481794cee2eb858c0846a360fc52a6ee89b7fcc55fa42e77251d4ae
BLAKE2b-256 checksum
How to use checksums
fb6c0581d85d0f67528f1c4df1b871f41d38d4a92fa5421df3e8609eae31ca57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 15, 2026.

Transparency log

Release files / policyengine_core-3.36.1-py3-none-any.whl

Download URL policyengine_core-3.36.1-py3-none-any.whl
Size 318.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
522d55800b900c69a2b52be7345ac206b5c0af3873cd34be3239cd98b881e6ae
BLAKE2b-256 checksum
How to use checksums
cd38da632a97f45ce030c7eca10eda66d3938dfe88dfa1620f25b1b7bca05376
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 15, 2026.

Transparency log

Security for policyengine-core 3.36.1

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for policyengine_core-3.36.1.tar.gz

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 Nov 15, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.36.1 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page