Folium Plugin to Support PMTiles
Project description
🗺️ Folium Plugin to support PMTiles
Basic usage
Vector
import folium
from folium_pmtiles.vector import PMTilesVector
m = folium.Map(location=[43.7798, 11.24148], zoom_start=12, tiles=None)
pmtiles_layer = PMTilesVector(
"https://protomaps.github.io/PMTiles/protomaps(vector)ODbL_firenze.pmtiles",
"folium_layer_name",
options={
"attribution": """<a href="https://protomaps.com">Protomaps</a> © <a href="https://openstreetmap.org/copyright">OpenStreetMap</a>'"""
},
)
m.add_child(pmtiles_layer)
See https://github.com/protomaps/protomaps.js/blob/eb9ca41a7469d30beada65f53cd51d94ea77c305/src/frontends/leaflet.ts#L42-L63 for valid options
Raster
import folium
from folium_pmtiles.raster import PMTilesRaster
m = folium.Map(location=[43.7798, 11.24148], zoom_start=2, tiles=None)
pmtiles_layer = PMTilesRaster(
"https://protomaps.github.io/PMTiles/stamen_toner(raster)CC-BY+ODbL_z3.pmtiles",
"folium_layer_name",
options={
"attribution": """Map tiles by <a href="http://stamen.com">Stamen Design</a>, under <a href="http://creativecommons.org/licenses/by/3.0">CC BY 3.0</a>. Data by <a href="http://openstreetmap.org">OpenStreetMap</a>, under <a href="http://www.openstreetmap.org/copyright">ODbL</a>."""
},
)
m.add_child(pmtiles_layer)
see https://leafletjs.com/reference.html#gridlayer-option for valid options
Dev Setup
poetry install --with dev
poetry run pre-commit install
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
folium-pmtiles-0.1.0.tar.gz
(2.6 kB
view hashes)
Built Distribution
Close
Hashes for folium_pmtiles-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfe6165a4c2843bfc08339d21dd6047bb7ac8e4a463f6bcccbd681911501d6b5 |
|
MD5 | 7f5452af6b2cd907965074f08bed7e32 |
|
BLAKE2b-256 | 1e48c610a252fc0a3fc86d0177b2788511ab5980cd5e286fa01f56e12cc05cf0 |