Skip to main content

OpenFisca Rules as Code model for Country-Template.

Project description

OpenFisca Country-Template

This repository helps you quickly set up and use your own OpenFisca country package.

You should NOT fork it but follow the set up instructions below.

Otherwise, you will have to clean up all tags when you deploy your own country package.

Setting up your Country Package

This set of instructions only needs to be followed once and will create your own copy of this boilerplate directory, customising it to the country you want to work on. You will need to have Git installed.

Using GitHub (recommended for GitHub users)

  1. Click on the “Use this template” dropdown and select “Create a new repository”.

  2. Set the repository name to openfisca-<your_country_name>; use underscore _ as separator if there are spaces in the country name. For example, openfisca-new_zealand or openfisca-france.

  3. After being redirected to your newly created repository, please allow a few minutes for the automatic setup to be executed. Once done, the title of the README file should be updated to OpenFisca <your_country_name>.

If the automatic setup does not start within a few minutes, you can initiate it manually:

  • Navigate to the “Actions” tab.
  • Select the “First time setup” workflow.
  • Click on “Run workflow” to start the setup process manually.
  1. Follow the instructions in the new repository's

Manual setup (recommended for users of other Git hosts)

  1. Download a copy of this repository, unzip it and cd into it in a Terminal window.

  2. Create a new repository on your favourite git host (Bitbucket, GitLab, …) with the name openfisca-<your_country_name>. For example, openfisca-new_zealand or openfisca-france.

  3. Execute the script to initialise the git repository. This performs numerous tasks including replacing all references to openfisca-country_template with references to the new country package.

    • To execute the script run bash from the command line
    • After the has run both it and these instructions are removed.
  4. Follow the instructions in the new repository's

Writing the Legislation

The country whose law is modelled here has a very simple tax and benefit system.

  • It has a flat rate tax whose rates increase every year.
  • On the first of December, 2015, it introduced a basic income for all its citizens of age who have no income.
  • On the first of December, 2016, it removed the income condition, providing all its adult citizens with a basic income.

These elements are described in different folders. All the modelling happens within the openfisca_country_template folder.

  • The rates are in the parameters folder.
  • The formulas are in the variables folder.
  • This country package comes also with reforms in the reforms folder. This is optional: your country may exist without defining any reform.
    • In this country, there is a reform project aiming to modify the social security taxation, deleting the first bracket, raising the intermediary ones and adding a new bracket with a higher tax rate of 40 % for people earning more than 40000. This reform project would apply starting from 2017-01-01.

The files that are outside from the openfisca_country_template folder are used to set up the development environment.

Packaging your Country Package for Distribution

Country packages are python distributions. To distribute your package via pip, follow the steps given by the Python Packaging Authority.

Install Instructions for Users and Contributors

This package requires Python 3.9. More recent versions should work, but are not tested.

All platforms that can execute Python are supported, which includes GNU/Linux, macOS and Microsoft Windows.

Setting-up a Virtual Environment with venv

In order to limit dependencies conflicts, we recommend using a virtual environment with venv.

  • A venv is a project specific environment created to suit the needs of the project you are working on.

To create a virtual environment, launch a terminal on your computer, cd into your directory and follow these instructions:

python3 -m venv .venv # create a new virtual environment in the “.venv” folder, which will contain all dependencies
source .venv/bin/activate # activate the venv

You can now operate in the venv you just created.

You can deactivate that venv at any time with deactivate.

:tada: You are now ready to install this OpenFisca Country Package!

Two install procedures are available. Pick procedure A or B below depending on how you plan to use this Country Package.

A. Minimal Installation (Pip Install)

Follow this installation if you wish to:

  • run calculations on a large population;
  • create tax & benefits simulations;
  • write an extension to this legislation (e.g. city specific tax & benefits);
  • serve your Country Package with the OpenFisca Web API.

For more advanced uses, head to the Advanced Installation.

Install this Country Package with Pip Install

Inside your venv, check the prerequisites:

python --version  # should print "Python 3.9.xx".
pip --version  # should print at least 9.0.
# if not, run "pip install --upgrade pip"

Install the Country Package:

pip install openfisca-country_template

:warning: Please beware that installing the Country Package with pip is dependent on its maintainers publishing said package.

:tada: This OpenFisca Country Package is now installed and ready!

Next Steps

Depending on what you want to do with OpenFisca, you may want to install yet other packages in your venv:

B. Advanced Installation (Git Clone)

Follow this tutorial if you wish to:

  • create or change this Country Package's legislation;
  • contribute to the source code.

Clone this Country Package with Git

First, make sure Git is installed on your machine.

Set your working directory to the location where you want this OpenFisca Country Package cloned.

Inside your venv, check the prerequisites:

python --version  # should print "Python 3.9.xx".

Clone this Country Package on your machine:

git clone
cd repository_folder
pip install --upgrade pip build twine
pip install --editable .[dev] --upgrade

You can make sure that everything is working by running the provided tests with make test.

Learn more about tests

:tada: This OpenFisca Country Package is now installed and ready!

Next Steps

Serve this Country Package with the OpenFisca Web API

If you are considering building a web application, you can use the packaged OpenFisca Web API with your Country Package.

To serve the Openfisca Web API locally, run:

openfisca serve --port 5000 --country-package openfisca_country_template

Or use the quick-start Make command:

make serve-local

To read more about the openfisca serve command, check out its documentation.

You can make sure that your instance of the API is working by requesting:

curl "http://localhost:5000/spec"

This endpoint returns the Open API specification of your API.

:tada: This OpenFisca Country Package is now served by the OpenFisca Web API! To learn more, go to the OpenFisca Web API documentation.

You can test your new Web API by sending it example JSON data located in the situation_examples folder.

curl -X POST -H "Content-Type: application/json" \
  -d @./openfisca_country_template/situation_examples/couple.json \

Project details

Release history Release notifications | RSS feed

This version


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openfisca_country_template-7.1.1.tar.gz (33.5 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page