Metadata-Version: 2.1
Name: altair_tiles
Version: 0.2.0
Summary: altair_tiles
Project-URL: Source, https://github.com/altair-viz/altair_tiles
Author: altair_tiles contributors
License-File: LICENSE
Keywords: altair,basemaps,tiles
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: altair
Requires-Dist: mercantile
Requires-Dist: xyzservices
Provides-Extra: dev
Requires-Dist: geopandas; extra == 'dev'
Requires-Dist: ghp-import; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: ipykernel; extra == 'dev'
Requires-Dist: ipython; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff>=0.1.4; extra == 'dev'
Requires-Dist: vega-datasets; extra == 'dev'
Requires-Dist: vl-convert-python; extra == 'dev'
Provides-Extra: doc
Requires-Dist: jupyter-book; extra == 'doc'
Requires-Dist: vl-convert-python; extra == 'doc'
Description-Content-Type: text/markdown

<img src="https://raw.githubusercontent.com/altair-viz/altair_tiles/main/doc/logo.svg" height="110"></img>

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](https://github.com/geopandas/contextily) package which provides this functionality for [matplotlib](https://matplotlib.org/).

You can find the documentation [here](https://altair-viz.github.io/altair_tiles). For a general introduction to plotting geographic data with Altair, see [Geoshape - Vega-Altair](https://altair-viz.github.io/user_guide/marks/geoshape.html) and [Specifying Data - Vega-Altair](https://altair-viz.github.io/user_guide/data.html#spatial-data).

## Installation
```bash
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
```bash
python -m venv .venv
source .venv/bin/activate
pip install -e '.[dev]'
```

Run linters and tests with
```bash
hatch run test
```

Build and view the documentation with
```bash
hatch run doc:clean
hatch run doc:build
hatch run doc:serve
```

To run a clean build and publish, run
```bash
hatch run doc:build-and-publish
```
