From 26abf3303249bfa234c783011b42bf6d47cf7678 Mon Sep 17 00:00:00 2001 From: Florian Pagnoux Date: Tue, 11 Oct 2016 12:29:38 +0200 Subject: [PATCH 1/8] Update openfisca installation process --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 82dd0f6fe9..10579bf41e 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,22 @@ npm install If you need to add features to the API, the best is to [`npm link`](https://docs.npmjs.com/cli/link) `sgmap/mes-aides-api` into `mes-aides-ui`, to avoid depending on the published version. +Openfisca +--------- + +```sh +cd mes-aides-ui +pip install -r openfisca/requirements.txt +``` + +### Development mode + +If you are working on `openfisca-france` and want to use your local version: +``` +cd (...)/openfisca-france +pip install -e . +``` + Usage ----- From 25dcda26fcda63545ab59ce8e5635bc82d196db6 Mon Sep 17 00:00:00 2001 From: Florian Pagnoux Date: Tue, 11 Oct 2016 12:33:44 +0200 Subject: [PATCH 2/8] Update deployment process --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 10579bf41e..b286a794e0 100644 --- a/README.md +++ b/README.md @@ -141,8 +141,7 @@ Pousser sur `sgmap/mes-aides-ui#master` la version du code à déployer. ### OpenFisca -Commiter et pousser l'état des différents sous-modules dans `sgmap/openfisca`. - +Editer le fichier `openfisca/requirements.txt` en y indiquant le version d'openfisca que vous souhaitez utiliser. Déploiement From 4b9d9353a8e20a7717e8cffc7a19eb83761f5b53 Mon Sep 17 00:00:00 2001 From: Florian Pagnoux Date: Tue, 11 Oct 2016 12:38:28 +0200 Subject: [PATCH 3/8] Update openfisca starting process --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b286a794e0..2915a4c09b 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,12 @@ First, start a Mongo server: npm run db & ``` -Then, start the server: +Then, start the Openfisca server: +```sh +paster serve openfisca/api_config.ini +``` + +Finally, start the server: ```sh npm start From dc87f7c053c32085787c27c45787c82add276c66 Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Tue, 11 Oct 2016 17:57:44 +0200 Subject: [PATCH 4/8] Fix typos --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2915a4c09b..48625a9d9c 100644 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ Pousser sur `sgmap/mes-aides-ui#master` la version du code à déployer. ### OpenFisca -Editer le fichier `openfisca/requirements.txt` en y indiquant le version d'openfisca que vous souhaitez utiliser. +Éditer le fichier `openfisca/requirements.txt` en y indiquant la version d'Openfisca que vous souhaitez utiliser. Déploiement From a1fe1db94bb51960a9436fe11dd213436df6de07 Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Tue, 11 Oct 2016 17:58:25 +0200 Subject: [PATCH 5/8] Add user and upgrade options to Openfisca install --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 48625a9d9c..78b59cef3e 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Openfisca ```sh cd mes-aides-ui -pip install -r openfisca/requirements.txt +pip install --user --upgrade -r openfisca/requirements.txt ``` ### Development mode From a3ec658205b098b00bbe57b5876c86aa52db5079 Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Tue, 11 Oct 2016 18:00:57 +0200 Subject: [PATCH 6/8] Document requirements.txt --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 78b59cef3e..6420c90691 100644 --- a/README.md +++ b/README.md @@ -148,6 +148,8 @@ Pousser sur `sgmap/mes-aides-ui#master` la version du code à déployer. Éditer le fichier `openfisca/requirements.txt` en y indiquant la version d'Openfisca que vous souhaitez utiliser. +Ce fichier est au format [`requirements.txt`](https://pip.pypa.io/en/stable/reference/pip_install/#example-requirements-file) de `pip`. Généralement, vous le mettrez à jour pour faire pointer l'un des modules Openfisca vers une branche de développement en attendant la publication de ce module sur PyPI. + Déploiement ----------- From 3810d0774210e51ec9d0db5716d72c3229f276d5 Mon Sep 17 00:00:00 2001 From: Florian Pagnoux Date: Wed, 12 Oct 2016 15:55:13 +0200 Subject: [PATCH 7/8] Add openfisca install and launch scripts to npm --- README.md | 4 ++-- package.json | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6420c90691..696c163983 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Openfisca ```sh cd mes-aides-ui -pip install --user --upgrade -r openfisca/requirements.txt +npm run install-openfisca # ou pip install --upgrade -r openfisca/requirements.txt si vous utilisez un environnement virtuel ``` ### Development mode @@ -76,7 +76,7 @@ npm run db & Then, start the Openfisca server: ```sh -paster serve openfisca/api_config.ini +npm run openfisca ``` Finally, start the server: diff --git a/package.json b/package.json index 48da75b5be..5e569e6561 100644 --- a/package.json +++ b/package.json @@ -72,7 +72,9 @@ "test-integration": "test/integration/run-integration-tests.sh", "predb": "mkdir -p db", "db": "mongod --dbpath db", - "db-update": "./import-tests.sh" + "db-update": "./import-tests.sh", + "install-openfisca": "pip install --user --upgrade -r openfisca/requirements.txt", + "openfisca":"paster serve openfisca/api_config.ini" }, "license": "AGPL-3.0" } From 28e42ddfb70d790c0c93fc3d7b0ca6a0a5c28ed7 Mon Sep 17 00:00:00 2001 From: Florian Pagnoux Date: Fri, 14 Oct 2016 19:21:28 +0200 Subject: [PATCH 8/8] Document pip dependency --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 696c163983..c233d4a509 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ ## Cette documentation est technique. Pour plus d'informations sur [Mes Aides](https://mes-aides.gouv.fr), regardez notre [wiki](https://github.com/sgmap/mes-aides-ui/wiki). -The user interface (and main server) for [mes-aides](https://mes-aides.gouv.fr), a French benefits simulation application for citizens. - -> L'interface utilisateur (et le serveur principal) de [mes-aides](https://mes-aides.gouv.fr), un estimateur des prestations sociales françaises pour les particuliers. +L'interface utilisateur (et le serveur principal) de [mes-aides](https://mes-aides.gouv.fr), un estimateur des prestations sociales françaises pour les particuliers. Il est basé sur simulateur socio-fiscal libre [Openfisca](https://www.openfisca.fr/). Installing @@ -22,10 +20,12 @@ sudo apt-get install mongodb ### For all platforms -The runtime is Node 0.10. +The runtime is Node 0.10 for the web application, and Python 2.7 for Openfisca. You can for example use [`nvm`](https://github.com/creationix/nvm) to install this specific version. +You will need [`pip`](https://pip.pypa.io/) to install Openfisca. + ### In production