adyax/french-zip-code

3.0.3 2019-03-05 16:03 UTC

README

A propos

L'objectif de ce dépôt est de maintenir une liste la plus à jour possible des régions, départements, villes et villages Français en Métropole, Département et Région d'Outre-Mer (DROM) et Collectivités d'Outre-Mer (COM).

Origine des données

Les données utilisées proviennent du site de l'INSEE :

Métropole et DROM ⚠️

Les fichiers fournit sont au format .txt encodés en ISO-8859-15 avec CRLF. Il convient de les convertir en UTF-8 avec LF.

COM

La page indiquer est la ressource disponible, elle est donc parsée afin d'extraire la liste de entitées Départements, villes et villages.

Clone, outils requis et commandes

Le dépôt utilise plusieurs technologies requises sur votre système d'exploitation :

  • Docker afin de concevoir les environnements de travail (apache, php7 et mysql).

  • Make afin de mettre des commandes simple à disposition (Makefile).

  • Cloner le projet dans un répertoire de votre ordinateur.

  • Mettez à jour les fichiers présent dans ./storage/builder avec les nouvelles ressources de l'INSEE :

    • cities.txt
    • departments.txt
    • regions.txt
  • Editer le ficher .env.exemple et enregistrer le sous .env, modifier les différentes variables requises :

    • APP_KEY pour un bon fonctionnement de l'appli.
    • GOOGLE_MAPS_KEY une clé valide d'accès à Google Maps API Geocoding.
    • COM_URI si la ressource des COM de l'INSEE à changer.
  • Dirigez vous dans son dossier en ligne de commande.

  • Faite alors un make start qui vas lancer le projet via docker.

  • Une fois le projet initialisé, faite un make builder qui vas lancer au travers des containers docker la récupération.

  • Lorsque le build sera terminer, vous pourrez demander un export des données dans ./Exports via la commande make export.

Commandes make

  • make help permet de lister toutes les commandes disponible.
  • make start permet de lancer le projet.
  • make stop permet de stopper le projet.
  • make restart composition de make stop et make start permet de relancer le projet.
  • make builder permet de lancer la génération des données.
  • make export permet de lancer l'export des données générer.

Participer

Si vous le souhaitez vous pouvez participer à ce projet en améliorant le système :

  • De build utiliser par php artisan builder:build
  • D'export utiliser par php artisan builder:export

Releases

Les données sont fournit dans 3 formats (csv, json et sql) afin que le maximum de personnes puissent les utiliser. Les fichiers disponibles utilisent un systeme de liaison permettant de naviger facilement entre les listes utilisant les codes INSEE de l'élément cible. Vous trouverez ci-dessous les éléments listés dans chaque fichiers.

Régions (regions)

Information Clé
L'ID unique id
Le code INSEE de la région code
Le nom name
L'identifiant slug

Départements (departments)

Information Clé
L'ID unique id
La code INSEE de la région de référence region_code
Le code INSEE du département code
Le nom name
L'identifiant slug

Villes et villages (cities)

Information Clé
L'ID unique id
Le code INSEE du département de référence department_code
Le code INSEE de la ville / du village code
Le code postal zip_code
Le nom name
L'identifiant slug
La latitude gps_lat
La longitude gps_lng

Pourquoi ce dépôt

En effet, les listes actuellement disponible sur internet ne sont visiblement pas à jour, qu'elle proviennent d'organisme tel que data.gouv.fr ou de site tel que sql.sh