Skip to main content

Django model to store and serve mapbox base layer config

Project description

codecov CI

Django Mapbox Baselayer

Django application to store, manage and serve map base layers and overlay configurations for MapLibre GL JS and Mapbox GL JS.

This package provides:

  • Django models to store base layers and overlay layers configuration
  • Admin interface to manage layers
  • API endpoints to serve layer configurations as TileJSON
  • Support for raster tiles, vector tiles, and Mapbox styles

Map Example

Getting started

Installation

Install it in your project like any dependency

pip install django-mapbox-baselayer

Usage

Declare django-mapbox-baselayer in the INSTALLED_APPS

# settings.py

INSTALLED_APPS  = [
    # ... other django apps
    "mapbox_baselayer",
]

For Mapbox base layers, you do not need to describe the tiles with the BaseLayerTile object, but an url is mandatory.

For Raster base layers, is it necessary to create a BaseLayerTile for each url (a.tiles.xxx, b.tiles.xxx, etc ...)

Tile size should be 256 for raster and 512 for vector.

Commands

Unified install_layer command

# OSM base layer
./manage.py install_layer osm
./manage.py install_layer osm --order 2

# OpenTopoMap base layer
./manage.py install_layer opentopomap
./manage.py install_layer opentopomap --order 3

# IGN base layers (list available layers)
./manage.py install_layer ign

# IGN base layers (install specific layers)
./manage.py install_layer ign ortho plan maps scan_25 cadastre plan_vt
./manage.py install_layer ign maps scan_25 --key my_api_key --order=1
./manage.py install_layer ign cadastre --overlay

CHANGELOG

1.2.1 (2026-02-13)

Improvements

  • Provide function to get layer list without url fetch.

1.2.0 (2026-02-10)

Improvements

  • Provide default OSM base layer if no layer in database.
  • Change default glyph by demo glyph to avoid map style problems on raster based layer.
  • Commands are replaced by ìnstall_layer command with different options to install different layers.
  • Use proxy models in admin for Base layers / Overlays / Style URL / Raster.
  • Customize forms for Raster or Style URL layers
  • Ability to enable / disable layers in admin without deleting them.

1.1.1 (2026-02-07)

Improvements

  • mapbox url is now labeled as "Style URL".
  • IGN Plan Vector tile layer is available

Bugfixes

  • IGN layers are updated to use the new style url instead of the old tile url.

Development

  • Use ruff instead of flake / black / isort

1.1.0 (2026-02-06)

New features

  • Add overlays concept to allow adding layers on top of baselayers. This is useful for example to add a layer with markers on top of a baselayer.
  • Add JSON endpoint to get baselayer data. This is useful for example to get the real url of a mapbox style.

Improvements

  • Add example view

Maintenance

  • Drop official support for python <= 3.9
  • Add official support for python 3.13
  • Add official support for python 5.2 and 6.0

1.0.0 (2023-07-11)

  • Increase attribution size to 1024 chars.
  • Support django 4.2, drop django 2.2
  • Support python 3.11

0.0.9 (2022-11-09)

  • Improve install_ign_baselayer command. Add Plan IGN V2 and fix multi layer import.
  • Support django 3.2, 4.0 and 4.1
  • Support python 3.10

0.0.8 (2020-11-03)

  • Add command to create Mapbox layer
  • Add command to create different IGN layers

0.0.7 (2020-10-30)

  • Admin is now registered by default. Delete enabling code in your project.
  • Set default mapbox glyphs to avoid map style problems on raster based layer
  • Add commands to create OSM and OpenTopoMap base layers

0.0.6 (2020-09-09)

  • Support django 3.1

0.0.5 (2020-06-03)

  • Fix translations

0.0.4 (2019-12-04)

  • Allow using map_box_url to store vector external json

0.0.3 (2019-12-03)

  • add tile Size option for raster layers
  • add attribution option for all layers
  • Add real_url property to model MapBaseLayer, to get real url for mapbox styles
  • fix MapBaseLayer deletion
  • Enable fr translation

0.0.2 (2019-11-29)

  • Increase tile url max size

0.0.1 (2019-11-25)

  • First release

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_mapbox_baselayer-1.2.1.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_mapbox_baselayer-1.2.1-py3-none-any.whl (37.6 kB view details)

Uploaded Python 3

File details

Details for the file django_mapbox_baselayer-1.2.1.tar.gz.

File metadata

  • Download URL: django_mapbox_baselayer-1.2.1.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for django_mapbox_baselayer-1.2.1.tar.gz
Algorithm Hash digest
SHA256 b7c127694c48b2e0b0c2578e8e8da9e3cbee707c28107e4a847a03aab00a4da7
MD5 7e316513af4ffaafbb61069d9484e5ec
BLAKE2b-256 449c24ab4343d4d1d89491f935571198012e66f1053a482e4370ca0517c48d9c

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_mapbox_baselayer-1.2.1.tar.gz:

Publisher: python-ci.yml on makinacorpus/django-mapbox-baselayer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_mapbox_baselayer-1.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_mapbox_baselayer-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 64e190037cc579fe598f8b9aba9e5cd84de292772be573bb87faaf24d5a78670
MD5 9a3a2763ca6a165074311c1303a4811e
BLAKE2b-256 86a92ef0dfd17c4b0fea6b7d311c71a38e3044633a87b1927f59736c753283d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_mapbox_baselayer-1.2.1-py3-none-any.whl:

Publisher: python-ci.yml on makinacorpus/django-mapbox-baselayer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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