``contextily``: context geo tiles in Python
===========================================

``contextily`` is a small Python 3 (3.8 and above) package to retrieve
tile maps from the internet. It can add those tiles as basemap to
matplotlib figures or write tile maps to disk into geospatial raster
files. Bounding boxes can be passed in both WGS84 (``EPSG:4326``) and
Spheric Mercator (``EPSG:3857``). See the notebook
``contextily_guide.ipynb`` for usage.

.. figure:: tiles.png
   :alt: Tiles

   Tiles

The current tile providers that are available in contextily are the
providers defined in the
```xyzservices`` <https://xyzservices.readthedocs.io>`__ package. This
includes some popular tile maps, such as:

- The standard `OpenStreetMap <http://openstreetmap.org>`__ map tiles
- Toner, Terrain and Watercolor map tiles by `Stamen
  Design <http://stamen.com>`__

Dependencies
------------

- ``mercantile``
- ``numpy``
- ``matplotlib``
- ``pillow``
- ``rasterio``
- ``requests``
- ``geopy``
- ``joblib``
- ``xyzservices``

Installation
------------

**Python 3 only** (3.8 and above)

`Latest released
version <https://github.com/geopandas/contextily/releases/>`__, using
pip:

.. code:: sh

   pip3 install contextily

or conda:

.. code:: sh

   conda install contextily

Contributors
------------

``contextily`` is developed by a community of enthusiastic volunteers.
You can see a full list
`here <https://github.com/geopandas/contextily/graphs/contributors>`__.

If you would like to contribute to the project, have a look at the list
of `open issues <https://github.com/geopandas/contextily/issues>`__,
particularly those labeled as `good first
contributions <https://github.com/geopandas/contextily/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-contribution>`__.

License
-------

BSD compatible. See ``LICENSE.txt``
