-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Introduce situations example #23
Conversation
Tutorials in [python](https://www.python.org) programming language for [reforms](http://openfisca.org/doc/reforms.html) creation on the French tax and benefit system. | ||
### [Python tutorials for OpenFisca-France](./python/) | ||
|
||
With the Python [Tutorials](./python/) (in French), you will learn how to: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Redondant ?
README.md
Outdated
With the Python [Tutorials](./python/) (in French), you will learn how to: | ||
- use the python API to run calculations | ||
- get results on the current legislation as well as on reforms | ||
- export calculation result to CSV |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CSV file format or
.csv
files ?
README.md
Outdated
- export calculation result to CSV | ||
|
||
### [Situations for OpenFisca-France](./python/situations) | ||
This directory contains pre-filled situations extracted from the French "Livret du pouvoir d'achat". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ajouter le lien vers le livret ? : https://www.economie.gouv.fr/files/files/PLF2018/bro-pouvoir-achat-bat-web-10h.pdf
README.md
Outdated
### [Situations for OpenFisca-France](./python/situations) | ||
This directory contains pre-filled situations extracted from the French "Livret du pouvoir d'achat". | ||
|
||
You can use them 'as is' in the web API or import them in the python API as shown in the python tutorials. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ajouter le lien vers https://legislation.openfisca.fr/swagger dans
web API
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to not have too many external links because I saw a user click on links in the tutorial read me thinking it was links to tutorials.
README.md
Outdated
- get results on the current legislation as well as on reforms | ||
- export calculation result to CSV | ||
|
||
### [Situations for OpenFisca-France](./python/situations) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Input data for OpenFisca-France
? Les nouveaux usagers peuvent ne pas identifier ce qu'on entend par situation.
README.md
Outdated
### [Python scripts for OpenFisca-France](./python/scripts) | ||
- [`openfisca_json_customizer.py`](./python/scripts/openfisca_json_customizer.py) takes in an OpenFisca situation and customizes it thanks to a few helper methods. | ||
- [`clean_mes_aides_situation.py`](./python/scripts/clean_mes_aides_situation.py) takes in a [Mes Aides](https://mes-aides.gouv.fr) situation and turns it into an OpenFisca-France situation. | ||
- [`generate_situation_example`](./python/scripts/generate_situation_examples) contains the `situation_example package`, along with the `try_situation_examples.py` script. The `situation_example package` contains complete cookie cutter situations (single, couple, roommates) thant are ready to use in the python API, and the web API (in their json form) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ajout de 's' et placement des ticks sur le nom du répertoire :
The situation_examples
package contains...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo, 'n' en trop :
roommates) that are ready
README.md
Outdated
|
||
You can use them 'as is' in the web API or import them in the python API as shown in the python tutorials. | ||
|
||
### [Python scripts for OpenFisca-France](./python/scripts) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ajouter la ligne de commande pour les exécuter ? Ex :
To run one of the following scripts, go to its directory an call it withpython
command.
Connected to openfisca/openfisca-france#883
Ajoute un script qui permet de facilement générer des situations type en format python.