Skip to main content

A Python library for creating interactive web maps, optimized for LLM-assisted development.

Project description

LLMaps

Python License MapLibre

A Python library for creating interactive web maps, optimized for LLM-assisted development.

Encapsulates best practices for interactive web map development behind a predictable, composable API — so both you and your LLM produce correct code on the first try. Outputs a single HTML file powered by MapLibre GL JS.

Table of Contents

Features

  • Declarative API — composable Map + layers + sources + components. Describe what the map should show; the library handles how.
  • Single HTML output — standalone file with MapLibre GL JS; works via file:// when data is embedded.
  • Embedded mode — inline GeoJSON (optionally Geobuf + Gzip) so you can share one file.
  • Comparison mode — before/after slider using the MapLibre compare plugin.
  • Feature-state expressions — GPU-efficient dynamic styling (fill_color, opacity) via setFeatureState.
  • Extensible — custom JS/CSS/HTML injection, embed_data() for arbitrary JSON.
  • Built-in attribution — automatic LLMaps branding with GitHub link (customizable or removable).
  • LLM-friendly — predictable names, stable contracts; use get_llm_context() for a compact reference in chat.

Available building blocks:

Category Classes
Layers CircleLayer, FillLayer, H3Layer, VectorTileLayer
Sources FileSource, ApiSource, VectorTileSource
Components Legend, Popup, Sidebar, Search, FeatureSearch, Controls, BasemapSwitcher

Installation

pip install llmaps

Optional extras:

pip install llmaps[h3]           # H3 aggregation (h3, geopandas)
pip install llmaps[compression]  # Geobuf + Gzip for embedded data
pip install llmaps[all]          # h3 + compression

Context for LLM: To give your LLM the right context when generating map code, run this in your project directory once. Then in chat use @llmaps_context.md:

python -c "import llmaps; open('llmaps_context.md','w').write(llmaps.get_llm_context())"

Quick Start

from llmaps import Map
from llmaps.layers import CircleLayer
from llmaps.sources import FileSource
from llmaps.components import Legend, Popup, Controls

source = FileSource(id="points", path="data/points.geojson")
layer = CircleLayer(
    id="points-layer",
    source=source,
    radius=6,
    color="#3182bd",
    opacity=0.8,
)

m = Map(center=[10.0, 50.0], zoom=4, title="My Map", tiles="osm")
m.add_layer(layer)
m.add_component(Legend(layer_labels={"points-layer": "Points"}))
m.add_component(Popup(fields=["name", "value"], field_labels={"name": "Name", "value": "Value"}))
m.add_component(Controls(zoom=True, scale=True))

m.auto_extent()
m.save("my_map.html")

Attribution

By default, all maps include a LLMaps attribution with a link to the GitHub repository:

# Default LLMaps attribution
m = Map(center=[10.0, 50.0], zoom=5)
# Result: "© OpenStreetMap contributors | © LLMaps"

You can customize or disable the attribution:

# Custom attribution
m = Map(center=[10.0, 50.0], zoom=5, custom_attribution='© My Company')

# Disable custom attribution
m = Map(center=[10.0, 50.0], zoom=5, custom_attribution=None)
# Result: "© OpenStreetMap contributors"

Examples

Example Description
01_quick_start.py Circle layer, legend, popup, controls; synthetic points.
02_fill_layer.py Fill layer (polygons).
03_h3_heatmap.py H3 hexagon heatmap, embedded mode, auto_extent.
04_comparison.py Before/after comparison with slider; embedded.

Run an example:

cd examples
python 01_quick_start.py
# Opens or writes 01_quick_start.html

Built With

Comparison with Alternatives

Criterion Kepler.gl Folium / ipyleaflet Custom MapLibre/Leaflet LLMaps
Ready-made components Limited by UI Few map primitives None Full set: layers, legend, popup, sidebar, search, controls
LLM-friendly No Partial (verbose) Depends on custom code Yes: keyword index, clear API, stable contracts
H3 / aggregation Yes No (manual) Manual Yes (H3Layer)
Embedded (file://) No Often needs server Manual Yes (embedded=True)
Comparison (before/after) No No Manual Yes (enable_comparison)
Single HTML output No Possible Manual Yes (save / to_html)
Customization Limited by UI Good Full Full (config + templates + custom JS/CSS)
No backend No Often Possible Yes (embedded mode)

When to use LLMaps: You want a single Python API to produce a standalone interactive map (especially with embedded data), with minimal boilerplate and good support for LLM-generated code.

When to choose something else: You need a full GIS UI (Kepler.gl), tight Jupyter-only integration (Folium/ipyleaflet), or a fully custom frontend stack (raw MapLibre/Leaflet with your own backend).

Architecture

Python API  →  Config (to_dict())  →  HTML (Jinja2)  →  Frontend (MapLibre GL JS + plugins)

Everything reduces to a serializable dict — no framework magic. The generator turns that config into one HTML file with inline or linked JS/CSS. See PHILOSOPHY.md for design principles and rationale.

Documentation

  • LLM context — run python -c "import llmaps; open('llmaps_context.md','w').write(llmaps.get_llm_context())" and use @llmaps_context.md in chat for a compact API reference.
  • PHILOSOPHY.md — Concept, design principles, comparison with alternatives.
  • docs/api/ — Map, layers, sources, components (parameters and examples).
  • docs/recipes/ — Heatmap, comparison, embedded map, feature-state highlighting.

Tile Providers

Use the tiles argument when creating the map:

Key Provider Attribution
"osm" OpenStreetMap (default) © OpenStreetMap contributors
"carto-light" Carto Light © OpenStreetMap contributors, © CARTO
"carto-dark" Carto Dark © OpenStreetMap contributors, © CARTO
"yandex" Yandex Maps © Yandex Maps
"2gis" 2GIS © 2GIS

License

MIT. See LICENSE.

Contact

Sergey Abramov

Telegram Email

Contributing

See CONTRIBUTING.md.

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

llmaps-0.1.0.tar.gz (3.6 MB view details)

Uploaded Source

Built Distribution

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

llmaps-0.1.0-py3-none-any.whl (62.8 kB view details)

Uploaded Python 3

File details

Details for the file llmaps-0.1.0.tar.gz.

File metadata

  • Download URL: llmaps-0.1.0.tar.gz
  • Upload date:
  • Size: 3.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for llmaps-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2bc6f5dca59940f0d99a51180bbcb36b6df6e271cf15582e6a53a27a275cbbe6
MD5 51262a84dc2674953b088c69d687702c
BLAKE2b-256 ee5a3f518d7ecfaf103107a4e85bcc14ac7cee9288966e55269b1313c5100b85

See more details on using hashes here.

File details

Details for the file llmaps-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: llmaps-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 62.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for llmaps-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b9dcc5c21fabc56c4fa16f60c73489d5a163ffdfa7c4f2e7ef6a1318f47e5816
MD5 cdef1fa476e156173f80084e1385a188
BLAKE2b-256 d76e0d5ea728f28a1f9a1b0801d98c8f0dac31d4dccc00c46e860eefcc0f0b3a

See more details on using hashes here.

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