OpenFisca PF

This is the package modelling the French Polynesia tax system. What is currently modelled:

• CST-S
• IT
• CST-NS

But this is a work in progress and none of those taxes are validated yet.

Installation for developpers and maintainers

Installation does not work on windows despite using Python, but it is working well in a WSL. To install WSL on Windows 10: https://docs.microsoft.com/fr-fr/windows/wsl/install-win10

To install it first get the git repo :

git clone https://github.com/govpf/openfisca-pf.git

Then make sure you have all dependencies (this example is for Ubuntu or Debian based distro):

sudo apt-get update
sudo apt upgrade
sudo apt-get install make python3-pip

Pip is named pip 3 in Ubuntu so you should add an alias:

echo "alias pip='pip3'" >> ~/.bash_aliases
source ~/.bashrc

Then you can install openfisca :

cd openfisca-pf
pip install --editable .[dev] --upgrade

Then make sure your openfiscal installation is in your path:

echo "export PATH=$HOME/.local/bin:${PATH}:" >> ~/.bashrc
source ~/.bashrc

Running all the tests

To run all non regression tests you have to execute :

openfisca test --country-package openfisca_pf openfisca_pf/tests

Serve this Country Package with the OpenFisca Web API

To serve the Openfisca Web API locally, run:

openfisca serve --configuration-file config.py

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.

🎉 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.

Substitute your package's country name for openfisca_pf below:

curl -X POST -H "Content-Type: application/json" \
  -d @./openfisca_pf/situation_examples/couple.json \
  http://localhost:5000/calculate

Run or Build an Openfisca-pf docker image

To run the offical latest Openfisca-pf image simply run :

docker run -p 5000:5000 govpf/openfisca-pf:latest

But if you want to build it yourself, while being in the main directory of the project run :

docker build --tag openfisca-pf-mytag . -f docker/Dockerfile

Then you may run this image :

docker run -p 5000:5000 openfisca-pf-mytag