# policyengine-core

> React component library for PolicyEngine

Latest version **1.0.18** (published 2021-10-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install policyengine-core
pnpm add policyengine-core
yarn add policyengine-core
bun add policyengine-core
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.18 |
| Published | 2021-10-15 |
| First published | 2021-10-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 22 |
| Unpacked size | 254.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 22 |
| Author | nikhilwoodruff |
| Maintainers | policyengine |

## Links

- npm: https://www.npmjs.com/package/policyengine-core
- Repository: https://github.com/policyengine/policyengine-core
- Homepage: https://github.com/policyengine/policyengine-core#readme
- Issues: https://github.com/policyengine/policyengine-core/issues
- npm.io page: https://npm.io/package/policyengine-core

## Dependencies (22)

- [antd](https://npm.io/package/antd.md) ^4.16.13
- [react](https://npm.io/package/react.md) ^17.0.2
- [grommet](https://npm.io/package/grommet.md) ^2.18.0
- [polished](https://npm.io/package/polished.md) ^4.1.3
- [bootstrap](https://npm.io/package/bootstrap.md) ^5.1.3
- [plotly.js](https://npm.io/package/plotly.js.md) ^1.58.5
- [react-dom](https://npm.io/package/react-dom.md) ^17.0.2
- [ga-4-react](https://npm.io/package/ga-4-react.md) ^0.1.281
- [rehype-raw](https://npm.io/package/rehype-raw.md) ^6.1.0
- [react-share](https://npm.io/package/react-share.md) ^4.4.0
- [@mui/material](https://npm.io/package/@mui/material.md) ^5.0.2
- [framer-motion](https://npm.io/package/framer-motion.md) ^4.1.17
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.4.1
- [react-markdown](https://npm.io/package/react-markdown.md) ^7.0.1
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^11.0.0
- [react-bootstrap](https://npm.io/package/react-bootstrap.md) ^1.6.4
- [react-plotly.js](https://npm.io/package/react-plotly.js.md) ^2.5.1
- [react-router-ga](https://npm.io/package/react-router-ga.md) ^1.2.3
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.3.0
- [@ant-design/icons](https://npm.io/package/@ant-design/icons.md) ^4.7.0
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.12.3
- [styled-components](https://npm.io/package/styled-components.md) ^5.3.1

## Recent versions

- 1.0.18 (latest) — 2021-10-15
- 1.0.17 — 2021-10-14
- 1.0.16 — 2021-10-14
- 1.0.15 — 2021-10-13
- 1.0.14 — 2021-10-13
- 1.0.13 — 2021-10-12
- 1.0.12 — 2021-10-12
- 1.0.11 — 2021-10-12
- 1.0.10 — 2021-10-12
- 1.0.9 — 2021-10-12
- 1.0.8 — 2021-10-12
- 1.0.7 — 2021-10-12
- 1.0.6 — 2021-10-12
- 1.0.5 — 2021-10-12
- 1.0.4 — 2021-10-11
- … 4 more at https://npm.io/package/policyengine-core/versions

## README

# PolicyEngine Core

[![codecov](https://codecov.io/gh/PolicyEngine/policyengine-core/branch/master/graph/badge.svg?token=BLoCjCf5Qr)](https://codecov.io/gh/PolicyEngine/policyengine-core)
[![PyPI version](https://badge.fury.io/py/policyengine-core.svg)](https://badge.fury.io/py/policyengine-core)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

A fork of [OpenFisca-Core](https://github.com/OpenFisca/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

```bash
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:

```python
from policyengine_core.simulations import Simulation
from policyengine_core.reforms import Reform
```

See the [documentation](https://policyengine.github.io/policyengine-core/) for API reference and tutorials.

## Development

```bash
# 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](./CONTRIBUTING.md) for branching, PR conventions, and the towncrier `changelog.d/` workflow. Default branch is `master`.

## License

Distributed under the AGPL License. See [`LICENSE`](./LICENSE) for details.

## Acknowledgements

- Forked from [OpenFisca-Core](https://github.com/OpenFisca/OpenFisca-Core).
- README template adapted from Othneil Drew's [Best-README-Template](https://github.com/othneildrew/Best-README-Template).

---
_Source: https://npm.io/package/policyengine-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
