Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Évolutions v0.3.0 : suppression id_lieu, id_local devient obligatoire #29

Merged
merged 9 commits into from
Dec 19, 2023
10 changes: 8 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@

Ce fichier répertorie les changements entre différentes versions d'un schéma.

## Version 0.3.0 - 2023-09-01
- La colonne `id_lieu` est supprimée
- La colonne `id_local` devient obligatoire
- Mise à jour des exemples CSV correct/incorrect
- Mise à jour du README

## Version 0.2.8 - 2023-07-17
- Correction de l'exemple CSV correct
- Mise à jour des liens des exemples dans le `schema.json`
- Mise à jour du readme
- Mise à jour du README

## Version 0.2.7 - 2023-04-13
- Mise à jour du readme : ajout d'une information concernant la sécurité des aires
- Mise à jour du README : ajout d'une information concernant la sécurité des aires

## Version 0.2.6 - 2022-08-26
- Correction de la valeur d'exemple du champ `id_lieu`
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ Dans le but de constituer un répertoire national des lieux de covoiturage, ouve

Les différents moyens permettant de contribuer sont détaillés dans la documentation "[Contribution à la Base nationale des Lieux de Covoiturage (BNLC)](https://doc.transport.data.gouv.fr/producteurs/lieux-de-covoiturage/contribuer-a-la-base-nationale-des-lieux-de-covoiturage)".

En cas de contribution directement sur data.gouv.fr, il faut sélectionner le schéma `Lieu de covoiturage` lors de la publication du jeu de données. [Plus de détails sur l'ajout d'un schéma](https://guides.data.gouv.fr/publier-des-donnees/guide-qualite/maitriser-les-schemas-de-donnees/indiquer-et-verifier-quune-ressource-respecte-un-schema-de-donnees)
En cas de contribution directement sur data.gouv.fr, il faut sélectionner le schéma `Lieu de covoiturage` lors de la publication du jeu de données, afin que celui-ci soit ajouté automatiquement à la BNLC. [Plus de détails sur l'ajout d'un schéma](https://guides.data.gouv.fr/publier-des-donnees/guide-qualite/maitriser-les-schemas-de-donnees/indiquer-et-verifier-quune-ressource-respecte-un-schema-de-donnees)

### Format des fichiers
Le fichier doit être un fichier CSV, encodé en UTF-8 et utilisant le point-virgule comme séparateur de colonnes. L'en-tête de colonne sur la première ligne est obligatoire. Tous les champs du schéma sont obligatoires ; si la donnée n'est pas disponible, la colonne doit malgré tout être présente mais vide.
Le fichier doit être un fichier CSV, encodé en UTF-8 et utilisant la virgule comme séparateur de colonnes. L'en-tête de colonne sur la première ligne est obligatoire. Tous les champs du schéma sont obligatoires ; si la donnée n'est pas disponible, la colonne doit malgré tout être présente mais vide.

Lorsque vous contribuez via data.gouv.fr, nous préconisons ce format de nom du fichier : `AAAAMMJJ_idproducteur_lieuxcovoit.csv` où `AAAAMMJJ`est la date de mise à jour des données et `idproducteur` est le SIREN de la collectivité productrice des données. Par exemple pour le département de l'Ain, avec des données mises à jour le 18 juin 2023 : `20230618_220100010_lieuxcovoit.csv`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je dirais que c'est inutile en cas de dépôt/remplacement de fichiers sur data.gouv.fr. Peut-être faire un tour sur le README et harmoniser avec la doc côté PAN ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Qu'est-ce qui est inutile @AntoineAugusti , de définir le séparateur ou d'insérer toutes les colonnes même vides ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je parlais du paragraphe qui aborde la convention de nommage à respecter pour le fichier.


Expand Down
6 changes: 3 additions & 3 deletions exemple-invalide.csv
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahah j'avais oublié que j'avais fait les fichiers d'exemples de ce schéma

Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
id_lieu;id_local;nom_lieu;ad_lieu;com_lieu;insee;type;date_maj;ouvert;source;Xlong;Ylat;nbre_pl;nbre_pmr;duree;horaires;proprio;lumiere;comm
76217-C-001;23X01;Gare SNCF de Dieppe;2 Boulevard Georges Clemenceau;Dieppe;76217;Parking;2019-06-25;true;217602176;1.081183;49.921823;20;2;;true;Ville de Dieppe;true;Correspondance avec la ligne TER Dieppe-Rouen
76217-C-002;23X02;Gare Routière de Dieppe;2 Avenue Victor Louis;Dieppe;76000;Parking;24-06-2019;true;576578587;49.921921;1.065656;2;3;;false;Ville de Dieppe;true;Proximité de la gare SNCF
id_local,nom_lieu,ad_lieu,com_lieu,insee,type,date_maj,ouvert,source,Xlong,Ylat,nbre_pl,nbre_pmr,duree,horaires,proprio,lumiere,comm
23X01,Gare SNCF de Dieppe,2 Boulevard Georges Clemenceau,Dieppe,76217,Parking,2019-06-25,true,217602176,1.081183,49.921823,20,2,,true,Ville de Dieppe,true,Correspondance avec la ligne TER Dieppe-Rouen
23X02,Gare Routière de Dieppe,2 Avenue Victor Louis,Dieppe,76000,Parking,24-06-2019,true,576578587,49.921921,1.065656,2,3,,false,Ville de Dieppe,true,Proximité de la gare SNCF
4 changes: 2 additions & 2 deletions exemple-valide.csv
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
id_lieu;id_local;nom_lieu;ad_lieu;com_lieu;insee;type;date_maj;ouvert;source;Xlong;Ylat;nbre_pl;nbre_pmr;duree;horaires;proprio;lumiere;comm
"76217-C-001";;Gare SNCF de Dieppe;2 Boulevard Georges Clemenceau;Dieppe;76217;Parking;2019-06-25;true;217602176;1.081183;49.921823;20;2;;true;Ville de Dieppe;true;"Correspondance avec la ligne TER Dieppe-Rouen"
id_local,nom_lieu,ad_lieu,com_lieu,insee,type,date_maj,ouvert,source,Xlong,Ylat,nbre_pl,nbre_pmr,duree,horaires,proprio,lumiere,comm
23X01,Gare SNCF de Dieppe,2 Boulevard Georges Clemenceau,Dieppe,76217,Parking,2019-06-25,true,217602176,1.081183,49.921823,20,2,,true,Ville de Dieppe,true,"Correspondance avec la ligne TER Dieppe-Rouen"
25 changes: 7 additions & 18 deletions schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@
{
"title": "Ressource valide",
"name": "exemple-valide",
"path": "https://github.com/etalab/schema-lieux-covoiturage/raw/v0.2.2/exemple-valide.csv"
"path": "https://github.com/etalab/schema-lieux-covoiturage/raw/v0.3.0/exemple-valide.csv"
},
{
"title": "Ressource invalide",
"name": "exemple-invalide",
"path": "https://github.com/etalab/schema-lieux-covoiturage/raw/v0.2.2/exemple-invalide.csv"
"path": "https://github.com/etalab/schema-lieux-covoiturage/raw/v0.3.0/exemple-invalide.csv"
Comment on lines +22 to +27
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AurelienC J'ai ajouté ceci

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On s'était posé la question : pourquoi mettre l'url "en dur" vers la version plutôt que de pointer vers la dernière version via "raw" ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vers la dernière version à chaque fois tu veux dire ?

Pour que les précédentes versions des schémas maintiennent des liens valides et cohérents avec le contenu de schema.json. C'est pas un gros sujet, généralement les gens utilisent la dernière version.

Mais sans ça le fichier d'exemple ne correspond pas au schéma potentiellement pour les versions précédentes

}
],
"author":"Antoine Augusti pour Etalab",
"contact":"contact@transport.beta.gouv.fr",
"contributors": [
{
"title": "Miryad Ali et Francis Chabouis",
"title": "Miryad Ali, Francis Chabouis, Aurélien Cadiou",
"email": "contact@transport.beta.gouv.fr",
AurelienC marked this conversation as resolved.
Show resolved Hide resolved
"organisation": "transport.data.gouv.fr",
"role": "contributor"
Expand Down Expand Up @@ -73,30 +73,20 @@
"role": "contributor"
}
],
"version":"0.2.8",
"version":"0.3.0",
"created":"2019-06-25",
"lastModified":"2023-07-17",
"lastModified":"2023-09-01",
"homepage":"https://github.com/etalab/schema-lieux-covoiturage",
"uri":"https://github.com/etalab/lieux-covoiturage/blob/master/schema.json",
"example":"https://github.com/etalab/lieux-covoiturage/blob/master/exemple-valide.csv",
"fields":[
{
"name":"id_lieu",
"description":"Identifiant du lieu de covoiturage, délivré par le Point d'Accès National selon la règle INSEE-C-XXX où INSEE est le code INSEE de la commune et XXX est le numéro d’ordre d'arrivée dans la base sur 3 chiffres, commençant par 001. L'identifiant 35238-C-001 désigne ainsi la première aire référencée dans la commune de code INSEE 35238.",
"example":"35238-C-001",
"type":"string",
"constraints":{
"required":true,
"pattern":"^([013-9]\\d|2[AB1-9])\\d{3}-C-\\d{3}$"
}
},
{
"name":"id_local",
"description":"Identifiant du lieu de covoiturage fixé par le producteur de la donnée pour son propre usage",
"example":"23X01",
"type":"string",
"constraints":{
"required":false
"required":true
}
},
{
Expand Down Expand Up @@ -288,6 +278,5 @@
],
"missingValues":[
""
],
"primaryKey":"id_lieu"
Comment on lines -291 to -292
Copy link
Member

@AntoineAugusti AntoineAugusti Sep 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Retirer la clé primaire.

]
}
Loading