`catalogage-donnees-config`

Ce répertoire contient des fichiers de configuration relatifs à l'instance de production de l'outil catalogage-donnees en cours de développement.

La première instance de l'outil est déployée sur catalogue.data.gouv.fr et est coordonnée par la DINUM.

Pour plus d'informations, consultez la documentation à destination des utilisateurs.

Utilisation

Si vous voulez enregistrer une organisation sur catalogue.data.gouv.fr, avec ou sans catalogue, c'est ici que ça se passe !

L'activation du catalogue d'une organisation peut se faire au même moment que l'enregistrement de l'organisation elle-même, mais peut également avoir lieu dans un second temps. En effet, une organisation peut exister sans avoir de catalogue, par exemple afin de permettre à ses membres d'accéder au service et consulter les catalogues des autres organisations, tout en prenant le temps de préparer la création de son propre catalogue. Le choix du schéma du catalogue est un élément important de cette préparation. Il doit comporter à minima tous les champs du schéma commun, auxquels des "champs complémentaires" peuvent être ajoutés selon vos besoins métier.

⚠️ Attention, une fois un catalogue activé sur catalogue.data.gouv.fr, il n'est plus possible d'en modifier le schéma.

Enregistrer une organisation

Pour enregistrer une organisation sur catalogue.data.gouv.fr, nommée par exemple Mon ministère :

Créez un dossier dans organizations, par exemple organizations/mon-ministere.
Placez-y un fichier organization.json. Il doit respecter ce format :
```
[
  {
    "name": "Mon ministère",
    "siret": "00011122233333"
  }
]
```
N.B. Il est de votre responsabilité de vérifier que le numéro SIRET de l'organisation est valide et correspond bien à l'organisation cible.
[Optionnel] Vous pouvez rajouter le logo de votre organization en ajoutant un fichier logo.svg au dossier de votre organisation. Celui-ci doit obligatoirement être au format SVG
Créez une pull request (PR) avec ces changements. Un script automatisé vérifiera la conformité du fichier. La PR sera ensuite passée en revue par l'équipe de catalogue.data.gouv.fr.
Une fois la PR acceptée, un script automatisé enregistrera l'organisation sur catalogue.data.gouv.fr avec les informations renseignées.

🎉 Si vous faites partie de cette organisation, vous pouvez désormais vous connecter à catalogue.data.gouv.fr !

Activer le catalogue d'une organisation

Pour que le catalogue soit activé au moment de l'enregistrement de l'organisation sur catalogue.data.gouv.fr, cette procédure doit être faite dans la même pull request (PR). Commencez par les deux premières étapes décrites ci-dessus ("Enregistrer une organisation"), avant de continuer en suivant les étapes pour une des deux options suivantes ("Schéma commun" ou "Schéma spécifique").

⚠️ Attention, une fois le catalogue activé sur catalogue.data.gouv.fr, il n'est plus possible d'en modifier le schéma.

Schéma commun (sans champs complémentaires)

Placez une copie du schéma commun dans le dossier de votre organisation précédent créé, puis renommez le fichier catalog_schema.json. Vous pouvez personnaliser les métadonnées du schéma (name, description, etc.).
Créez une pull request (PR) avec l'ajout de ce fichier (ou intégrez-le à votre PR d'enregistrement d'organisation). Un script automatisé vérifiera la conformité des fichiers. La PR sera ensuite passée en revue par l'équipe de catalogue.data.gouv.fr.
Une fois la PR acceptée, un script automatisé activera le catalogue sur catalogue.data.gouv.fr (le cas échéant, en même temps que l'enregistrement de l'organisation).

🎉 Vous pouvez désormais contribuer au catalogue de votre organisation en y ajoutant des jeux de données !

Schéma spécifique (avec champs complémentaires)

Un schéma spécifique consiste à ajouter un ou plusieurs champs complémentaires au schéma commun. Vous pouvez en ajouter autant que nécessaire à la suite de ceux du schéma commun, en utilisant les types de champs suivants conformes à la spécification Table Schema :

string : une chaîne de caractères.
string avec une contrainte enum : une liste de valeurs.
boolean : un booléen.

Vous pouvez utiliser un exemple de schéma spécifique tel que celui du Ministère de la Culture.

Suivez les mêmes étapes que pour le "Schéma commun" ci-dessus en utilisant le schéma spécifique que vous avez créé, à la place du schéma commun.

Gestion de projet

Toute la partie gestion de projet (création et gestion des issues) se fait sur le repo catalogage-donne, disponnible à cette adresse:

https://github.com/etalab/catalogage-donnees/issues

Développement

Cette section est destinée à l'équipe de développement de ce dépôt.

Prérequis

Python 3.8+

Démarrage rapide

Pour installer les dépendances :

make install

Pour lancer les tests :

make test

(Un test supplémentaire qui interagit avec http://localhost:3579 s'exécute si le serveur local de catalogage-donnees tourne et que vous avez configuré les variables d'environnement en conséquence.)

Pour formatter automatiquement le code :

make format

Pour valider le code (format, linters, etc) et les organisations :

make check

Pour mettre en ligne manuellement les organisations nouvelles (ce script est normalement lancé par la CI, vous devrez donc être en possession des variables de configuration adéquates) :

make upload

Configuration

Variable d'environnement	Description	Valeur par défaut
`CATALOGAGE_API_URL`	URL de l'API de l'instance de `catalogage-donnees` sur laquelle créer les organisations.	Requis
`CATALOGAGE_API_KEY`	Clé d'API utilisée pour les requêtes HTTP avec l'API `catalogage-donnees`	Requis

Les valeurs liées à l'instance https://catalogue.multi.coop sont configurées dans les secrets GitHub Actions de ce dépôt.

En local, des valeurs liées à un serveur catalogage-donnees local peuvent être définies dans un fichier .env :

CATALOGAGE_API_URL="http://localhost:3579"
CATALOGAGE_API_KEY="..."  # (1)

(1) Doit correspondre à la variable APP_CONFIG_REPO_API_KEY côté catalogage-donnees. Voir Configuration (Démarrage rapide) | catalogage-donnees.

Licence

AGPL 3.0

QPC-github / catalogage-donnees-config