Skip to main content

A Django app to provide a database structure, API and import scripts to manage French communes, intercommunalités, départements and régions, with their structure and data from Insee and the DGCL.

Project description

https://badge.fury.io/py/django-francedata.svg https://github.com/entrepreneur-interet-general/django-francedata/actions/workflows/django.yml/badge.svg https://github.com/entrepreneur-interet-general/django-francedata/actions/workflows/codeql-analysis.yml/badge.svg

Django-Francedata

Provides a database structure, API and import scripts to manage French communes, intercommunalités, départements and régions, with their structure and data from Insee and the DGCL.

This app was created as a part of Open Collectivités.

Unaccent extension

If the PostgreSQL user specified in the Django settings is not a superuser, connect to the postgres user and create the Unaccent extension manually:

psql
\c <dbname>
"CREATE EXTENSION  IF NOT EXISTS unaccent;"

Quickstart

  1. Add “francedata” to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = [
        ...
        "django_json_widget",
        "simple_history",
        "francedata",
    ]
  2. Run python manage.py migrate to create the francedata models.

  3. Run the two initialization commands to get the communes, EPCIs, départements and régions structure:

    python manage.py cog_import
    python manage.py banatic_import
  4. Visit http://127.0.0.1:8000/admin/ to see the data.

Commands

cog_import:

  • goal: load the following data from the Code officiel géographique (COG): list of regions, departements and communes, with how they are linked and: * insee and siren ids for the regions/departements * insee for the communes

  • parameters: * –level: partial import of only the specified level (the script expects the higher ones to already be installed) Allowed values: regions, departements, communes * –years: import the specified year (min: 2019), by default it imports the latest available one in https://www.data.gouv.fr/fr/datasets/code-officiel-geographique-cog/

banatic_import:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_francedata-0.16.2.tar.gz (65.9 kB view hashes)

Uploaded Source

Built Distribution

django_francedata-0.16.2-py3-none-any.whl (89.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page