Récupération et nettoyage des données publiques (open data) de l'Assemblée nationale
Find a file
Henry Boisgibault 3ab0e3cc35
All checks were successful
Build and Push Docker Image / build (push) Successful in 27s
Build and Push Docker Image / release (push) Successful in 29s
2.5.0
2025-11-07 14:41:39 +01:00
.forgejo/workflows chore(release.yml, retrieve_videos.ts): update release workflow to trigger on tags and refactor video retrieval logic for improved clarity and functionality 2025-11-07 14:41:11 +01:00
doc Parallel download 2025-11-05 18:01:33 +01:00
images Don't fail when a picture of a sénateur is missing. Add default pictures. 2019-10-11 22:31:41 +02:00
src chore(release.yml, retrieve_videos.ts): update release workflow to trigger on tags and refactor video retrieval logic for improved clarity and functionality 2025-11-07 14:41:11 +01:00
.dockerignore Remove test & bugs. Prettify 2025-05-26 11:11:15 +02:00
.gitignore TexteLoi schema and parsing function 2024-06-12 16:15:20 +02:00
.prettierrc Use .prettierrc instead of prettier.config.js. Remove .prettierignore. Prettify 2025-05-26 11:11:28 +02:00
CHANGELOG.md feat: add full changelog 2025-06-28 08:16:15 +02:00
Dockerfile feat(Dockerfile, README.md, scripts): add fetchVideos option to enhance data retrieval capabilities and update documentation accordingly 2025-11-06 18:12:17 +01:00
eslint.config.mjs feat: Further ESLint configuration refinements 2025-05-26 11:11:28 +02:00
LICENSE.md chore: update Docker installation steps in release workflow and remove GitLab CI configuration while updating repository URLs in documentation and license files 2025-06-30 10:41:25 +02:00
package.json 2.5.0 2025-11-07 14:41:39 +01:00
README.md feat(Dockerfile, README.md, scripts): add fetchVideos option to enhance data retrieval capabilities and update documentation accordingly 2025-11-06 18:12:17 +01:00
tsconfig.json feat: Modernize build system with Vite and tsx, update to ES2020 2025-05-26 11:11:28 +02:00
vite.config.ts feat: export git submodule 2025-10-29 16:05:14 +01:00

Tricoteuses-Assemblee

Retrieve, clean up & handle French Assemblée nationale's open data

Tricoteuses Légifrance is free and open source software.

documentation

Requirements

  • Node >= 18

Installation

git clone https://git.tricoteuses.fr/logiciels/tricoteuses-assemblee
cd tricoteuses-assemblee/
npm install

Download and clean data

Basic usage

Create a directory to store the data, then run the following command to download, reorganize and clean the data.

mkdir ../assemblee-data/
npm run data:download ../assemblee-data

Available Commands

  • npm run data:download <dir>: Download, reorganize, and clean data
  • npm run data:retrieve_open_data <dir>: Download raw data files.
  • npm run data:reorganize_data <dir>: Reorganize raw files by entity.
  • npm run data:clean_data <dir>: Clean and validate reorganized files.
  • npm run data:retrieve_deputes_photos <dir>: Retrieval of députés' pictures from Assemblée nationale's website
  • npm run data:retrieve_senateurs_photos <dir>: Retrieval of sénateurs' pictures from Assemblée nationale's website
  • npm run data:retrieve_documents <dir>: Retrieval of legislative documents from Assemblée nationale's website
  • npm run data:retrieve_pending_amendements <dir>: Retrieval of pending amendments from Assemblée nationale's website (waiting to be processed by Assemblée services)

Notes:

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.

Examples:

# Only download amendments
npm run data:download ../assemblee-data -- -k Amendements

# Only process 16th and 17th legislatures
npm run data:download ../assemblee-data -- -l 16 -l 17

Common Options

  • --categories or -k <name>: Filter by dataset categories (Available options : ActeursEtOrganes, Agendas, Amendements, DossiersLegislatifs, Photos, Scrutins, Questions, ComptesRendusSeances)

  • --legislature or -l <number>: Specify one or more legislatures to process (e.g., -l 15 -l 16)

  • --dataDir <path> (Mandatory): Path to the working directory where all data is stored (required)

  • --silent or -s: Disable logging

  • --verbose or -v: Enable verbose logging

  • --fetch or -f: Force re-download of data even if already present

  • --commit or -c: Automatically commit cleaned data

  • --pull or -p: Pull repositories before starting

  • --clone or -C <url>: Clone Git repositories from a remote group or organization

  • --remote or -r <name>: Push commits to specified Git remote(s)

If you use such options, use them in all subsequent commands too (data:regorganize_data and data:clean_data).

Options for Cleaning Data

  • --dataset or -d <name>: Clean a specific dataset only
  • --no-reset-after-commit: Skip Git reset after committing (useful to preserve local changes)
  • --no-validate or -V: Skip schema validation during cleaning
  • --fetchDocuments : Specify to retrieve documents
  • --parseDocuments: Specify to parse documents into cleaned json
  • --fetchVideos: Retrieve videos

Options for Retrieving Documents

  • --full or -f: Retrieve all documents, even those already downloaded
  • --document-type or -T <type>: Restrict to specific document types (e.g., PION)

Download using Docker

A Docker image that downloads and cleans the data all at once is available. Build it locally or run it from the container registry. Use the environment variables LEGISLATURE and CATEGORIES if needed.

docker run --pull always --name tricoteuses-assemblee -v ../assemblee-data:/app/assemblee-data -e LEGISLATURE=17 -d git.tricoteuses.fr/logiciels/tricoteuses-assemblee:latest

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.

npm install @tricoteuses/assemblee
import {
  iterLoadAssembleeActeurs,
  iterLoadAssembleeOrganes,
  iterLoadAssembleeReunions,
  iterLoadAssembleeScrutins,
  iterLoadAssembleeDocuments,
  iterLoadAssembleeDossiersParlementaires,
  iterLoadAssembleeAmendements,
  iterLoadAssembleeQuestions,
  iterLoadAssembleeComptesRendus,
} from "@tricoteuses/assemblee/loaders";

// Pass data directory and legislature as arguments
for (const { acteur } of iterLoadAssembleeActeurs("../assemblee-data", 17)) {
  console.log(acteur.uid)
}

Generating schemas and documentation (for contributors only)

View instructions here