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

Conversation

AurelienC
Copy link
Contributor

@AurelienC AurelienC commented Aug 31, 2023

Evolutions du schéma vers une nouvelle version v0.3.0

L'obectif est d'avoir un schéma adapté à l'évolution prévue du mécanisme de contribution à la BNLC. L'évolution va permettre la consolidation automatique des jeux de données sur data.gouv.fr dans la BNLC. Lien : etalab/transport-site#3419

Cela implique, notamment :

  • de supprimer la colonne id_lieu, qui sera présente uniquement dans la BNLC, mais plus dans les jeux de données individuels ;
  • de rendre obligatoire la colonne id_local, afin qu'un identifiant reste présent.

- Mise à jour des liens des exemples dans le `schema.json`
- Mise à jour du readme
@AurelienC
Copy link
Contributor Author

AurelienC commented Aug 31, 2023

Todo à prévoir pour la publication de la nouvelle version :

  • Mettre à jour les fichiers d'exemples
  • Mettre à jour le champ version
  • Mettre à jour le champ lastModified
  • Changer les liens vers les fichiers d'exemples présents dans schema.json et README.md
  • Mettre à jour le fichier CHANGELOG.md en incluant une description de la version
  • Merger cette pull-request
  • Publier un nouveau tag et une nouvelle version
  • Prévenir les utilisateurs de ce schéma

@AntoineAugusti AntoineAugusti self-assigned this Sep 19, 2023
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

Comment on lines +22 to +27
"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"
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

Comment on lines -291 to -292
],
"primaryKey":"id_lieu"
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.

README.md Outdated

### 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.

@AntoineAugusti AntoineAugusti changed the title Evolutions v0.3.0 Évolutions v0.3.0 : suppression id_lieu, id_local devient obligatoire Sep 21, 2023
@AurelienC AurelienC marked this pull request as ready for review December 18, 2023 08:15
@AurelienC AurelienC requested a review from a team as a code owner December 18, 2023 08:15
Mise à jour date changelog V0.3.0
README.md Outdated Show resolved Hide resolved

### Fichiers d'exemple
Nous mettons à disposition des fichiers d'exemple qui peuvent servir de base pour renseigner vos lieux de covoiturage.

- [Télécharger un fichier exemple valide au format CSV](https://github.com/etalab/lieux-covoiturage/blob/master/exemple-valide.csv)
- [Télécharger un fichier d'exemple invalide](https://github.com/etalab/lieux-covoiturage/blob/master/exemple-invalide.csv) contenant des erreurs dans le formatage des dates et une inversion des coordonnées géographiques latitude/longitude
- [Télécharger un fichier exemple valide au format CSV](https://github.com/etalab/schema-lieux-covoiturage/raw/v0.3.0/exemple-valide.csv)
Copy link
Member

Choose a reason for hiding this comment

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

Faudra penser à mettre à jour ces liens avec les versions la prochaine fois du coup !

schema.json Outdated Show resolved Hide resolved
Co-authored-by: Antoine Augusti <antoine.augusti@beta.gouv.fr>
@AurelienC AurelienC merged commit 3c9c1df into master Dec 19, 2023
1 check passed
@AurelienC AurelienC deleted the evolutions_v0.3.0 branch December 19, 2023 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants