README.md 5.39 KB
Newer Older
Johan Richer's avatar
Johan Richer committed
1 2 3 4 5 6
# [DRAFT] Schémas du Socle commun des données locales (SCDL)

Ce dépôt sert à indexer les schémas du SCDL afin de permettre [leur documentation](http://scdl.opendatafrance.net/) et leur utilisation dans [Validata](https://go.validata.fr/).

Le [Socle commun des données locales](http://opendatalocale.net/scdl/) (SCDL) est un dispositif d'[OpenDataFrance](http://opendatafrance.net/) visant à définir un ensemble de jeux de données prioritaires, normalisés et communs aux collectivités territoriales françaises. Chaque jeu de données identifié fait l'objet d'un schéma : un document décrivant la structure, les champs et les contenus attendus.

Johan Richer's avatar
Johan Richer committed
7
Les schémas sont écrits au format [Table Schema](https://frictionlessdata.io/specs/table-schema/). A partir du JSON, une documentation est générée automatiquement au format Markdown et publiée sur [scdl.opendatafrance.net](http://scdl.opendatafrance.net/).
Johan Richer's avatar
Johan Richer committed
8 9 10 11 12

## Liste des schémas du SCDL

| Nom                 | Version | Mainteneur     | Dépôt                                                              |                                                    JSON                                                     | Doc                                                                           |
| ------------------- | ------- | -------------- | ------------------------------------------------------------------ |:-----------------------------------------------------------------------------------------------------------:| ----------------------------------------------------------------------------- |
Johan Richer's avatar
Johan Richer committed
13
| Prénoms             | 1.1.3   | Charles Népote | [URL](https://github.com/CharlesNepote/liste-prenoms-nouveaux-nes) | [URL](https://github.com/CharlesNepote/liste-prenoms-nouveaux-nes/raw/master/prenom-schema.json) | [URL](https://scdl.opendatafrance.net/docs/schemas/scdl-prenoms.html)         |
Johan Richer's avatar
Johan Richer committed
14 15 16 17
| Délibérations       | 2.1.2   | OpenDataFrance | [URL](https://git.opendatafrance.net/scdl/deliberations)           |               [URL](https://git.opendatafrance.net/scdl/deliberations/raw/master/schema.json)               | [URL](https://scdl.opendatafrance.net/docs/schemas/scdl-deliberations.html)   |
| Subventions         | 2.0.0   | OpenDataFrance | [URL](https://git.opendatafrance.net/scdl/subventions)             |                [URL](https://git.opendatafrance.net/scdl/subventions/raw/master/schema.json)                | [URL](https://scdl.opendatafrance.net/docs/schemas/scdl-subventions.html)     |
| Marchés publics     | 2.0.0   | OpenDataFrance | [URL](https://git.opendatafrance.net/scdl/marches-publics/)        |              [URL](https://git.opendatafrance.net/scdl/marches-publics/raw/master/schema.json)              | [URL](https://scdl.opendatafrance.net/docs/schemas/scdl-marches-publics.html) |
| Base Adresse locale | 1.1.3   | OpenDataFrance | [URL](https://git.opendatafrance.net/scdl/adresses)                |                 [URL](https://git.opendatafrance.net/scdl/adresses/raw/master/schema.json)                  | [URL](https://scdl.opendatafrance.net/docs/schemas/scdl-adresses.html)        |
Johan Richer's avatar
Johan Richer committed
18 19
| Catalogue simplifié | 0.1.1   | OpenDataFrance | [URL](https://git.opendatafrance.net/scdl/catalogue)               |                 [URL](https://git.opendatafrance.net/scdl/catalogue/raw/master/schema.json)                 | [URL](https://scdl.opendatafrance.net/docs/schemas/scdl-catalogue.html)       |
| Equipements         | 0.1.0   | OpenDataFrance | [URL](https://git.opendatafrance.net/scdl/equipements)             |                [URL](https://git.opendatafrance.net/scdl/equipements/raw/master/schema.json)                | [URL](https://scdl.opendatafrance.net/docs/schemas/scdl-equipements.html)     |
20
| IRVE                | 1.0.1   | Etalab         | [URL](https://github.com/etalab/schema-irve)                       |                     [URL](https://github.com/etalab/schema-irve/raw/master/schema.json)                     | [URL](https://scdl.opendatafrance.net/docs/schemas/scdl-irve.html)            |
Johan Richer's avatar
Johan Richer committed
21 22 23 24 25 26 27

## Comment ajouter un schéma au SCDL ?

Prochainement, le processus de contribution sera donc de faire une merge request sur ce dépôt  (instructions à venir).

### Critères d'acceptation

Johan Richer's avatar
Johan Richer committed
28
Pour faire partie du SCDL, un schéma doit être écrit en JSON conformément aux spécifications [Table Schema](https://frictionlessdata.io/specs/table-schema/). Ce fichier `schema.json` doit être publié dans un dépôt Git, auquel doivent être adjoints les ressources complémentaires suivantes :
Johan Richer's avatar
Johan Richer committed
29 30 31 32 33 34 35 36 37 38 39 40
* `CONTEXT.md`
* `SEE_ALSO.md`

Ces deux documents permettent de compléter les informations contextuelles inhérentes au schéma, et sont insérés [dans la documentation générée pour chaque schéma](https://scdl.opendatafrance.net/), en début et en fin de page.

Un fichier `CHANGELOG.md`, plus classique, apporte les informations sur les différentes mises à jour du schéma.

Des données tabulaires d'exemple en CSV, valides ou invalides, peuvent être également ajoutés dans un dossier séparé.

Nous recommandons par ailleurs l'usage des tags Git pour figer les versions de chaque schéma ainsi que les fichiers afférents cités ci-dessus. Plus d'informations à ce sujet [dans la documentation sur le cycle de vie des schémas dans Validata](https://git.opendatafrance.net/validata/validata-core/wikis/release-process).

Enfin, [OpenDataFrance](http://opendatafrance.net/) se réserve le droit d'accepter ou de refuser l'ajout d'un schéma au sein du SCDL.