metadata-swiss/CHOP-importer
Watch
1
mirror of https://github.com/metadata-swiss/CHOP-importer.git synced 2026-10-18 20:07:38 +00:00
Code Issues Releases Wiki Activity
Read-only mirror of https://github.com/metadata-swiss/CHOP-importer — Bundesamt für Statistik. Issues & pull requests at the source.
12 commits 1 branch 0 tags 49 KiB
  • Python 100%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Sergiy Goloviatinski 2a45d2987c Updated description in templates
2026-02-10 10:37:45 +01:00
templates Updated description in templates 2026-02-10 10:37:45 +01:00
.env.example The CHOP API is only accessible in admin network, so I rewrote the script to be executed locally instead of github Actions 2025-12-01 15:31:04 +01:00
.gitignore The CHOP API is only accessible in admin network, so I rewrote the script to be executed locally instead of github Actions 2025-12-01 15:31:04 +01:00
CHOPImporter.py Updated description in templates 2026-02-10 10:37:45 +01:00
config.py Updated README + updated mct api url 2025-12-18 10:30:08 +01:00
README.md Updated README + updated mct api url 2025-12-18 10:30:08 +01:00
requirements.txt Added contact mail in description + added urllib3 in requirements 2025-12-01 17:04:23 +01:00

README.md

CHOP-importer

This repo contains a script that imports CHOP as a concept in I14Y.

The required pip modules are listed in the requirements.txt file.

You have to create a .env file with the same variables as in .env.example.

The following env variables are needed:

  • I14Y_API_BASE_URL: i14y api url (different for ABN/DEV/PROD)
  • GET_TOKEN_URL: url to generate i14y token (different for ABN/DEV/PROD)
  • CLIENT_ID: client id to generate i14y token
  • CLIENT_SECRET: client secret to generate i14y token
  • CHOP_API_BASE_URL: MCT API url
  • CHOP_YEAR: Chop year
  • CHOP_REVISION: Chop revision (usually 99)
  • RESPONSIBLE_DEPUTY_GIVENNAME: Given name for responsible deputy
  • RESPONSIBLE_DEPUTY_FAMILYNAME: Family name for responsible deputy
  • RESPONSIBLE_DEPUTY_EMAIL: Email for responsible deputy
  • RESPONSIBLE_PERSON_GIVENNAME: Given name for responsible person
  • RESPONSIBLE_PERSON_FAMILYNAME: Family name for responsible person
  • RESPONSIBLE_PERSON_EMAIL: Email for responsible person
  • TEMPLATES_DIR: Folder containing description and title in different languages in .md files

The CHOP API provides the codeListEntries. The title and description for the concept are defined in the templates folder for different languages as .md files. The placeholder {YEAR} in those file will be replaced by the provided CHOP_YEAR env variable.

Parameters for the I14Y concept that are unlikely to change are defined in the build_data function in CHOPImporter.py file.