Update documentation

This commit is contained in:
Yorick Barbanneau 2022-05-02 21:36:35 +02:00
parent df13762b32
commit 8671af9b79

View file

@ -14,14 +14,15 @@ Il est vivement conseiller de faire fonctionner ce projet dans un
``` ```
cd projet_INSEE cd projet_INSEE
python -n venv .venv python -n venv .venv
./.venv/bin/activate source .venv/bin/activate
``` ```
3. intaller les prérequis: 3. intaller les prérequis:
``` ```
pip install -r requirements.txt pip install -r requirements.txt
``` ```
L'installation est maintenant opérationnelle L'installation est maintenant opérationnelle. Il faut penser à activer
l'environnement virtuel àa chaque nouvelle ouverture d'un terminal.
## Les éléments du projet ## Les éléments du projet
@ -43,7 +44,20 @@ C'est le script `createdatabase.py` qui se charge de la création de la base de
données et de l'importation des fichiers `csv` consolidés créés par le précédent données et de l'importation des fichiers `csv` consolidés créés par le précédent
script. script.
Une aide en ligne est aussi disponible Ce script nécessite un fichier de configuration avec les paramètres de
connection à la base PostgreSQL. Ce fiochier prend la forme suivante:
```
host=<host> user=<user> password=<password>
```
Les valeurs sont à remplacer par les votres.
La création des éléments se fait dans un nouveau schéma,il se nomme par défaut
`insee` maus peut être changé via le paramètre `--schema-name`.
Une aide en ligne est aussi disponible pour les détails des options
disponibles.
```sh ```sh
./createdatabase.py --help ./createdatabase.py --help