altair_tiles0.3.0
Published
altair_tiles
pip install altair-tiles
Package Downloads
Authors
Project URLs
Requires Python
>=3.8
Dependencies
- altair
- mercantile
- xyzservices
- geopandas
; extra == 'dev'
- ghp-import
; extra == 'dev'
- hatch
; extra == 'dev'
- ipykernel
; extra == 'dev'
- ipython
; extra == 'dev'
- mypy
; extra == 'dev'
- pytest
; extra == 'dev'
- ruff
>=0.1.4; extra == 'dev'
- vega-datasets
; extra == 'dev'
- vl-convert-python
; extra == 'dev'
- jupyter-book
; extra == 'doc'
- vl-convert-python
; extra == 'doc'
This package is in an early development stage. You should expect things to break unannounced until we release a version 1.0.0
.
You can use altair_tiles to add tiles from any xyz tile provider such as OpenStreetMap to your Altair chart. It is a counterpart to the amazing contextily package which provides this functionality for matplotlib.
You can find the documentation here. For a general introduction to plotting geographic data with Altair, see Geoshape - Vega-Altair and Specifying Data - Vega-Altair.
Installation
pip install altair_tiles
altair-tiles requires at least Vega version 5.26.0
. If you use an IDE such as a Jupyter Notebook or VS Code, you usually don't have to worry about this.
Development
python -m venv .venv
source .venv/bin/activate
pip install -e '.[dev]'
Run linters and tests with
hatch run test
Build and view the documentation with
hatch run doc:clean
hatch run doc:build
hatch run doc:serve
To run a clean build and publish, run
hatch run doc:build-and-publish