@tricoteuses/assemblee 2.0.2 → 2.1.0

package/README.md

@@ -7,7 +7,21 @@ _Tricoteuses Légifrance_ is free and open source software.
 - [software repository](https://git.en-root.org/tricoteuses/tricoteuses-assemblee)
 - [GNU Affero General Public License version 3 or greater](https://git.en-root.org/tricoteuses/tricoteuses-assemblee/-/tree/master/LICENSE.md)
 
-[Architecture](doc/architecture.md)
+## documentation
+
+- [Architecture](doc/architecture.md)
+- [TypeScript API](doc/api/)
+  - Main interfaces:
+    - [Acteur : personne physique élue ou nommée dans des organes](doc/api/README/interfaces/Acteur.md)
+    - [Amendement](doc/api/README/interfaces/Amendement.md)
+    - [CompteRendu : compte-rendu d'un débat parlementaire](doc/api/README/interfaces/CompteRendu.md)
+    - [Document : texte d'un projet de loi, d'une proposition de loi, d'un rapport, etc](doc/api/README/interfaces/Document.md)
+    - [DossierParlementaire : Dossier de suivi d'un projet ou d'une proposition de loi, d'une résolution, etc)](doc/api/README/interfaces/DossierParlementaire.md)
+    - [Organe : commission, groupe politique, groupe d'étude, groupe d'amitié, etc](doc/api/README/interfaces/Organe.md)
+    - [Question : question au Gouvernement](doc/api/README/interfaces/Question.md)
+    - [Reunion : séance publique, réunion de commission, de groupe d'étude, etc](doc/api/README/interfaces/Reunion.md)
+    - [Scrutin : vote de chaque député lors d'un scrutin public](doc/api/README/interfaces/Scrutin.md)
+- [JSON Schemas](src/schemas)
 
 ## Requirements
 
@@ -38,6 +52,7 @@ npm run data:download ../assemblee-data
 ```
 
 Data from other sources is also available :
+
 ```bash
 # Retrieval of députés' pictures from Assemblée nationale's website
 npm run data:retrieve_deputes_photos ../assemblee-data
@@ -50,26 +65,29 @@ npm run data:retrieve_pending_amendements ../assemblee-data
 ```
 
 _Notes_:
-- Reorganized files (generated by the *data:reorganize_data* command) are also available in [Tricoteuses / Data / Données brutes de l'Assemblée](https://git.en-root.org/tricoteuses/data/assemblee-brut). They are updated on a regular basis.
-- Split & cleaned files (generated by the *data:clean_data* command) are also available in [Tricoteuses / Data / Données nettoyées de l'Assemblée](https://git.en-root.org/tricoteuses/data/assemblee-nettoye) with the `_nettoye` suffix. They are updated on a regular basis.
+
+- Reorganized files (generated by the _data:reorganize_data_ command) are also available in [Tricoteuses / Data / Données brutes de l'Assemblée](https://git.en-root.org/tricoteuses/data/assemblee-brut). They are updated on a regular basis.
+- Split & cleaned files (generated by the _data:clean_data_ command) are also available in [Tricoteuses / Data / Données nettoyées de l'Assemblée](https://git.en-root.org/tricoteuses/data/assemblee-nettoye) with the `_nettoye` suffix. They are updated on a regular basis.
 
 ### Filtering options
 
 Downloading and cleaning all the data is long and takes up a lot of disk space. It is possible to choose the type of data that you want to retrieve to reduce the load.
 
-To download only a type of dataset, use the *--categories* option (shortcut *-k*) :
+To download only a type of dataset, use the _--categories_ option (shortcut _-k_) :
+
 ```bash
 # Available options : ActeursEtOrganes, Agendas, Amendements, DossiersLegislatifs, Photos, Scrutins, Questions, ComptesRendusSeances
 npm run data:download ../assemblee-data -- --categories Amendements
 ```
 
-To download only a specific legislature, use the *--legislature* option (shortcut *-l*):
+To download only a specific legislature, use the _--legislature_ option (shortcut _-l_):
+
 ```bash
 # Available options : 14, 15, 16, 17
 npm run data:download ../assemblee-data -- --legislature 17
 ```
 
-If you use such options, use them in all subsequent commands too (*data:regorganize_data* and *data:clean_data*).
+If you use such options, use them in all subsequent commands too (_data:regorganize_data_ and _data:clean_data_).
 
 ## Download using Docker
 
@@ -89,7 +107,7 @@ docker run --name tricoteuses-assemblee -v assemblee-data:/app/assemblee -e LEGI
 ## Using the data
 
 Once the data is downloaded and cleaned, you can use loaders to retrieve it.
-To use loaders in your project, you can install the *@tricoteuses/assemblee* package, and import the iterator functions that you need.
+To use loaders in your project, you can install the _@tricoteuses/assemblee_ package, and import the iterator functions that you need.
 
 ```bash
 npm install @tricoteuses/assemblee
@@ -106,7 +124,7 @@ import {
   iterLoadAssembleeAmendements,
   iterLoadAssembleeQuestions,
   iterLoadAssembleeComptesRendus,
-} from "@tricoteuses/assemblee/lib/loaders";
+} from "@tricoteuses/assemblee/loaders";
 
 // Pass data directory and legislature as arguments
 for (const { acteur } of iterLoadAssembleeActeurs("../assemblee-data", 17)) {