README.md

Extension OpenFisca pour nos partenariats avec les collectivités territoriales

Introduction

OpenFisca est un logiciel libre de micro-simulation. Ce dépôt contient la modélisation des aides locales françaises. Celles-ci enrichissent le modèle national de la France, openfisca-france.

Pour plus d'information sur les fonctionnalités et la manière d'utiliser OpenFisca, vous pouvez consulter la documentation générale.

Installation

Ce paquet requiert Python 3.9 ou supérieur et pip.

Afin d'installer l'extension openfisca-france-local, lancez une fenêtre de terminal et suivez les instructions suivantes pour en récupérer le code source :

git clone git@github.com:openfisca/openfisca-france-local.git

Puis, pour se rendre dans ce dossier openfisca-france-local

cd openfisca-france-local

Il y a plusieurs moyens de gérer ses environements (venv, docker, etc...) pour ne pas polluer son environement ou celui d'autres projets, voici une proposition avec venv :

python -m venv .venv # Creation de l'environement
source .venv/bin/activate # Activation de l'environement

Installation d'openfisca-france-local :

make install

Lancement des tests

Tester le bon fonctionnement d'OpenFisca

Une fois l'installation terminée, vous devriez pouvoir la tester avec les commandes suivantes :

openfisca test tests/test_dispositif.yml --country-package openfisca_france --extension openfisca_france_local

Ou plus simplement :

openfisca_local_test tests/test_dispositif.yml

Ceci exécute un test test_dispositif.yml faisant appel au module openfisca_france_local. Vous devriez obtenir un résultat se terminant par 1 passed in 0.0xs tel que dans cet exemple :

=================== test session starts ===================
platform linux -- Python 3.9.5, pytest-7.4.0, pluggy-1.2.0
rootdir: /home/user/dev/Aides-Jeunes/repos/openfisca-france-local
collected 2 items

tests/test_dispositif.yml ..
==================== 1 passed in 0.01s ====================

🎉 openfisca-france-local est prêt à être utilisé !

Lancer les tests :

Pour lancer tous les tests, vous pouvez utiliser :

make test

Pour lancer un dossier ou fichier de test spécifique : |

openfisca_local_test tests/Chemin/Vers/Dossier-fichier/cible

Rédaction des formules et tests

Vous trouverez un exemple d'aide dans le fichier communes/alfortville/noel_enfants.py, ainsi que le fichier de tests associé, tests/communes/alfortville/noel_enfants.yml. Les paramètres nécessaires au calcul se trouvent quant à eux dans le fichier openfisca_france_local/parameters/communes/alfortville.yml.

Pour ajouter des formules et tests, créez simplement des fichiers .py et .yml à l'intérieur du répertoire.