Rules-as-Code-League/openfisca_nsw_API

An umbrella repo that references all the other NSW Openfisca repos, so we can instantiate an API with all the extensions in it.

$EXT_NAME

This is a template for making extensions in NSW.

Initialising

You'll need to rename the openfisca_nsw_extension_template directory to the name of your extension. Also edit the README.md & setup.py files, and replace $EXT_NAME with the name of your extension. Replace $SHORT_NAME with a shortened name for it, for example openfisca_nsw_rules_kids_vouchers is shortened to "kids". This just makes it easier to switch to the virtual env.

Installing

We recommend that you use a virtualevn to install OpenFisca. If you don't, you may need to add --user at the end of all commands starting by pip.

python3 -m venv $SHORT_NAME
deactive
source $SHORT_NAME/bin/activate

To install your extension, run:

make extension

Testing

You can make sure that everything is working by running the provided tests:

make extension

To add your extension to the NSW API, update the openfisca-nsw-API repo's makefile with your extension's name, and add your extension as a dependency.

Learn more about tests.

Your extension package is now installed and ready!