docs: Ajout et correction autour de la documentation

This commit is contained in:
Simon C 2024-02-08 16:06:07 +01:00
parent afe39cc5c8
commit a60f9ca48c

View File

@ -2,14 +2,22 @@
Création d'une API unifié pour accéder à l'ensemble des données dont P4Pillon a besoin. Création d'une API unifié pour accéder à l'ensemble des données dont P4Pillon a besoin.
Le principe du projet est de pouvoir intérroger les données de l'open data depuis un réseau local et ainsi s'affranchir des pannes d'internet. Les données pourront être mise à jour régulièrement pour permettre d'avoir les dernières mise à jour. Le principe du projet est de pouvoir intérroger les données de l'open data depuis un réseau local et ainsi s'affranchir des pannes d'internet ou des APIs. Les données pourront être mise à jour régulièrement pour permettre d'avoir les dernières mise à jour.
## Liens
- [Source du projet](https://forge.p4pillon.org/P4Pillon/data)
- [Gestion des tâches](https://projets.p4pillon.org/projects/20/kanban#share-auth-token=wRsBFUyDFfKpcoadOezJjDesIyOtulPAMwwkqMHY)
- [API de P4Pillon](https://data.p4pillon.org)
- [Interface Swagger pour l'API](https://ui.data.p4pillon.org)
- [Support et questionnement](https://matrix.to/#/!UXjiUOiWQMEsMgMNMN:converser.eu)
## Données ## Données
Voici les données dont nous rappatrirons. Voici les données qui nous impotés.
### FINESS ### FINESS
Informations sur les établissements sanitaires, sociaux, médico-sociaux, et de formation aux professions de ces secteurs. Informations sur les établissements sanitaires, sociaux, médico-sociaux, et de formation aux professions de ces secteurs.
@ -17,7 +25,7 @@ Liens :
- [Site web](https://finess.esante.gouv.fr/) - [Site web](https://finess.esante.gouv.fr/)
- [Page web sur l'Open Data du gouvernement](https://www.data.gouv.fr/fr/datasets/finess-extraction-du-fichier-des-etablissements/) - [Page web sur l'Open Data du gouvernement](https://www.data.gouv.fr/fr/datasets/finess-extraction-du-fichier-des-etablissements/)
### INPI ### INPI
L'Institut national de la propriété industrielle, abrégé par le sigle INPI, est un établissement public à caractère administratif, placé sous la tutelle du ministère français de l'Économie, de l'Industrie et du Numérique. L'Institut national de la propriété industrielle, abrégé par le sigle INPI, est un établissement public à caractère administratif, placé sous la tutelle du ministère français de l'Économie, de l'Industrie et du Numérique.
@ -35,7 +43,7 @@ Il y a 2 posibilités pour récupérer les données de l'ensemble des entreprise
- Orchestrateur : [Docker Compose](https://docs.docker.com/compose/) - Orchestrateur : [Docker Compose](https://docs.docker.com/compose/)
## Script ## Script
Un script permet d'initialiser le projet en téléchargeant les dépendences, les données de l'Open Data ainsi que de transformer ses données en fichiers CSV. Un script permet d'initialiser le projet en téléchargeant les dépendences, les données de l'Open Data ainsi que de transformer ses données en fichiers CSV.
@ -56,8 +64,8 @@ La configuration se fait à l'aide d'un fichier `.env`, vous devez modifier les
Voici quelques commandes possibles : Voici quelques commandes possibles :
```bash ```bash
docker compose up -d # Création des conteneurs docker compose --env-file .env up -d # Création des conteneurs
docker compose down -v # Suppresion des conteneurs ainsi que des données docker compose --env-file .env down -v # Suppresion des conteneurs ainsi que des données
``` ```
### PostgreSQL ### PostgreSQL
@ -66,5 +74,5 @@ La fonction `COPY` est utilisé dans les fichiers SQL du dossier `./initdb` perm
### PostgREST ### PostgREST
Pour la configuration : https://postgrest.org/en/latest/configuration.html#environment-variables - Pour la configuration : https://postgrest.org/en/latest/configuration.html#environment-variables
Pour requêter des données : https://postgrest.org/en/stable/references/api/tables_views.html#horizontal-filtering-rows - Pour requêter des données : https://postgrest.org/en/stable/references/api/tables_views.html#horizontal-filtering-rows