Skip to main content

Integrated Django Vector Tile Server based on mbtiles

Project description

Django Tiles GL

Integrated Django Vector Tile Server based on mbtiles.

Description

Simple app to serve Mabpox Vector Tiles directly from MBTiles files via Django views.

Django Tiles has a minimal dependencies. It does not require GeoDjano or any other libraries. Its only dependency is Django itself.

Django Tiles GL does not create raster tiles. It may only be used with map libraries that support to render vector tiles like MapLibre or OpenLayers.

Django Tiles GL contains the OSM Bright map style which can be used to render Vector Tiles following the OpenMapTiles vector tile schema.

Note that this default style is using OpenSans fonts which does only contain Latin, Greek and Cyrillic alphabets.

Other tile schemes are possible by creating a custom map style specification and referencing Django Tiles GL TileJSON endpoint as a source.

Usage

See the demo Django application for a simple usage example.

Setup

  • Add django_tiles_gl to you INSTALLED_APPS setting.
  • Add django_tiles_gl.urls to your url patterns. For example with the tiles prefix:
    urlpatterns = [
        ...
        path("tiles/", include("django_tiles_gl.urls")),
    ]
    
  • Set path to your MBTiles files in you application settings.
    MBTILES_DATABASE = BASE_DIR / "demo" / "data" / "berlin.mbtiles"
    
  • Optionally set the default center to be set on the default map style.
    MBTILES_CENTER = [13.4, 52.5, 13]   # [longitude, latitude, zoom]
    
  • Optionally force absolute urls to use SSL by prefixing them with "https://". This might be required if you app is running behind a reverse proxy and you are not able to set SECURE_PROXY_SSL_HEADER from the SSL enabled proxy server.
    MBTILES_FORCE_SSL = True
    

Views

To render a map you have to include a JavaScript mapping library and refer to the tile endpoint or the default integrated style.

Django Tiles GL provides the following endpoints:

  • {% url 'django_tiles_gl:openmaptiles_style' %} - Default OpenMapTiles style defintion using the OSM Bright map style.
  • {% url 'django_tiles_gl:tilejson' %} - TileJSON describing the configured MBTiles files and providing the correct tile urls.
  • {% url 'django_tiles_gl:tile' x y z %} - Actual tile endpoint, returning vector data in the PBF format.

Django Tiles GL is bundles with MapLibre and provides a template tag for easy inclusion. A minimal working example has to contain the following defintions:

{% load tiles_gl_tags %}
<!DOCTYPE html>
<html>
<head>
    {% maplibre_head %}

    <style>
        body { margin:0; padding:0; }
        #map { position:absolute; top:0; bottom:0; width:100%; }
    </style>
</head>
<body>

<div id='map'></div>

<script>
var map = new maplibregl.Map({
	container: 'map',
	style: '{% url 'django_tiles_gl:openmaptiles_style' %}',
});
</script>

</body>
</html>

Data / MBTiles generation

There are mutiple tools to generate valid MBTiles databases. The easiest to use with Django Tiles GL is OpenMapTiles as it is compatible with the bundled default style.

For a quickstart you may generate the MbTiles for an area with the following commands:

git clone https://github.com/openmaptiles/openmaptiles.git
cd openmaptiles
./quickstart.sh <area>

Fo further information and optiones see https://github.com/openmaptiles/openmaptiles

Further Topics

Caching

It is advised setup a caching proxy for the tile endpoint. Please refer to you HTTP servers documentation. For example the nginx proxy cache config

Other Django tile server solutions

  • django-geojson-tiles - Generates GeoJSON tiles from a GeoDjango model. No MBTiles support. Not to be used as a base layer.

  • django-vectortiles - Generates Vector Tile layers from GeoDjango. No MBTiles support. Not to be used as a base layer.

  • django-mbtiles - Uses MBTiles to generate rastered tiles and UTFGrid. Does not support modern vector tiles. Strong inspiration for this project.

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_tiles_gl-0.3.9.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

django_tiles_gl-0.3.9-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

Details for the file django_tiles_gl-0.3.9.tar.gz.

File metadata

  • Download URL: django_tiles_gl-0.3.9.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.2 Linux/6.5.0-1025-azure

File hashes

Hashes for django_tiles_gl-0.3.9.tar.gz
Algorithm Hash digest
SHA256 3e3010c0a2925e50f20f49be5e5253e277176b3d3e2ca3fe0fa0ea861fc336a7
MD5 54b7cad34d81176e0c79159ef8cf68ca
BLAKE2b-256 c4792c6063644b5cfc39a408417dfd1e3d5b9b73c09aa26aef10a9ad961801d2

See more details on using hashes here.

File details

Details for the file django_tiles_gl-0.3.9-py3-none-any.whl.

File metadata

  • Download URL: django_tiles_gl-0.3.9-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.2 Linux/6.5.0-1025-azure

File hashes

Hashes for django_tiles_gl-0.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f110727cdee9d67001ffff29dbd3c71ce84f40dfcea6a8eadcfc97bd3d1e387c
MD5 ccaad18e631bd794f27abd8be579bac9
BLAKE2b-256 18c4e45cf2c8c0b4885675fb305305626af3e76f751d5a04a16acc6fc143f803

See more details on using hashes here.

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