Ce dépôt contient les fichiers nécessaires pour démarrer la création d'un dépôt pour un schéma Data Package.
- Si vous créez votre dépôt sur GitHub, il vous suffit d'appuyer sur le bouton vert "Use this template". Consultez la documentation pour plus d'infos ;
- Si votre projet sera hébergé ailleurs (par exemple Gitlab), vous pouvez cloner ce répertoire ou télécharger les fichiers correspondants. Utilisez le bouton "Clone or download".
Ce dépôt contient un ensemble de fichiers utiles pour un dépôt d'un schéma Data Package.
CHANGELOG.mdcontient la liste des changements entre les différentes versions de votre schéma ;LICENSE.mdest le fichier de licence du dépôt. Nous recommandons d'utiliser la Licence Ouverte, cette licence est recommandée par l'administration française pour le partage de données et de documents ;README.mdest le fichier que vous lisez actuellement. À terme, il devra présenter votre schéma ;requirements.txtliste les dépendances Python nécessaires pour effectuer des tests en intégration continue sur votre dépôt ;datapackage.jsonest le schéma au format Data Package qui fait référence à deux tables contenues dans les dossierstable1ettable2.
Ce dépôt est configuré pour utiliser de l'intégration continue, si vous utilisez GitHub. À chaque commit, une suite de tests sera lancée via GitHub Actions afin de vérifier :
- que votre schéma est valide à la spécification Data Package ;
- que vos fichiers d'exemples sont conformes au schéma.
Si vous n'utilisez pas GitHub, vous pouvez lancer ces tests sur votre machine ou sur un autre service d'intégration continue comme Gitlab CI, Jenkins, Circle CI, Travis etc. Consultez la configuration utilisée dans .github/workflows/test.yml.
Pour vous aider dans la construction de votre dépôt, nous vous recommandons de vous référer à :