Internationalise openfisca-serve script

openfisca / openfisca-web-api

[DEPRECATED] Web API for OpenFisca

https://www.openfisca.fr/

GNU Affero General Public License v3.0

13 stars 11 forks source link

Internationalise openfisca-serve script #98

Closed fpagnoux closed 7 years ago

fpagnoux commented 7 years ago

Make the script openfisca-serve work with any country
- Before, it was always loading openfisca-france
- Now, the country package (as well as reforms and extensions) can be provided through arguments
- If no country package is provided, an auto-detection is attempted
For more information about how to use the script, run openfisca-serve -h.

Usage :

openfisca-serve # will attempt an auto detection of the country package
openfisca-serve -c openfisca_senegal -p 14000
openfisca-serve -e openfisca_paris -r openfisca_france.reforms.aides_cd93.aides_cd93

Todo :

[ ] Update the gitbook doc

Fixes #80.

fpagnoux commented 7 years ago

Ideally I'd like to document this script like that one.

It would not make sense to put the doc for this script in openfisca-core, and I'm not sure it's worth building a new reference doc for openfisca-wep-api just for this script.

openfisca-serve -h gives good indication about the usage, do you think it's enough @cbenz ?

cbenz commented 7 years ago

If it's possible, we could merge the doc of openfisca-web-api on the same "readthedocs" namespace than openfisca-core.

Otherwise we can keep openfisca-serve -h only, and/or copy/paste the output of this command on gitbook.

fpagnoux commented 7 years ago

If it's possible, we could merge the doc of openfisca-web-api on the same "readthedocs" namespace than openfisca-core.

A readthedocs project can only refer to a single repository, so it's not obvious.

fpagnoux commented 7 years ago

@cbenz is it GTM ?