Metadata-Version: 2.1
Name: mapbox
Version: 0.16.2
Summary: A Python client for Mapbox services
Home-page: https://github.com/mapbox/mapbox-sdk-py
Author: Sean Gillies
Author-email: sean@mapbox.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: test
Requires-Dist: boto3 (>=1.4)
Requires-Dist: cachecontrol
Requires-Dist: iso3166
Requires-Dist: python-dateutil (>=2.5.0)
Requires-Dist: requests
Requires-Dist: polyline (>=1.3.1)
Requires-Dist: uritemplate (>=2.0)
Provides-Extra: test
Requires-Dist: coveralls; extra == 'test'
Requires-Dist: pytest (>=2.8.3); extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: responses; extra == 'test'
Requires-Dist: tox; extra == 'test'

=============
mapbox-sdk-py
=============

.. image:: https://travis-ci.org/mapbox/mapbox-sdk-py.png?branch=master
   :target: https://travis-ci.org/mapbox/mapbox-sdk-py

.. image:: https://coveralls.io/repos/mapbox/mapbox-sdk-py/badge.png
   :target: https://coveralls.io/r/mapbox/mapbox-sdk-py

A Python client for Mapbox web services

The Mapbox Python SDK is a low-level client API, not a Resource API such as the ones in `boto3 <http://aws.amazon.com/sdk-for-python/>`__ or `github3.py <https://github3py.readthedocs.org/en/master/>`__. Its methods return objects containing `HTTP responses <http://docs.python-requests.org/en/latest/api/#requests.Response>`__ from the Mapbox API.

Services
========

- **Analytics V1** `examples <./docs/analytics.md>`__, `website <https://www.mapbox.com/api-documentation/#analytics>`__

  - API usage for services by resource. 
  - available for premium and enterprise plans.

- **Directions V5** `examples <./docs/directions.md#directions>`__, `website <https://www.mapbox.com/api-documentation/?language=Python#directions>`__

  - Profiles for driving, walking, and cycling
  - GeoJSON & Polyline formatting

- **Distance V1** **DEPRECATED**
- **Geocoding V5** `examples <./docs/geocoding.md#geocoding>`__, `website <https://www.mapbox.com/api-documentation/?language=Python#geocoding>`__

  - Forward (place names ⇢ longitude, latitude)
  - Reverse (longitude, latitude ⇢ place names)

- **Map Matching V4** `examples <./docs/mapmatching.md#map-matching>`__, `website <https://www.mapbox.com/api-documentation/?language=Python#map-matching>`__

  - Snap GPS traces to OpenStreetMap data

- **Static Maps V4** `examples <./docs/static.md#static-maps>`__, `website <https://www.mapbox.com/api-documentation/pages/static_classic.html>`__

  - Generate standalone images from existing Mapbox *mapids* (tilesets)
  - Render with GeoJSON overlays

- **Static Styles V1** `examples <./docs/static.md#static-maps>`__, `website <https://www.mapbox.com/api-documentation/#static>`__

  - Generate standalone images from existing Mapbox *styles*
  - Render with GeoJSON overlays
  - Adjust pitch and bearing, decimal zoom levels

- **Surface V4** `examples <./docs/surface.md#surface>`__, `website <https://www.mapbox.com/developers/api/surface/>`__

  - Interpolates values along lines. Useful for elevation traces.

- **Uploads V1** `examples <./docs/uploads.md#uploads>`__, `website <https://www.mapbox.com/api-documentation/?language=Python#uploads>`__

  - Upload data to be processed and hosted by Mapbox.

- **Datasets V1** `examples <./docs/datasets.md#datasets>`__, `website <https://www.mapbox.com/api-documentation/?language=Python#datasets>`__

  - Manage editable collections of GeoJSON features
  - Persistent storage for custom geographic data

- **Maps V4** `examples <./docs/maps.md#maps>`__, `website <https://www.mapbox.com/api-documentation/?language=Python#maps>`__

  - Retrieve an image tile, vector tile, or UTFGrid in the specified format
  - Retrieve vector features from Mapbox Editor projects as GeoJSON or KML
  - Retrieve TileJSON metadata for a tileset
  - Retrieve a single marker image without any background map

Please note that there may be some lag between the release of new Mapbox web
services and releases of this package.

Documentation
=============

Please see https://mapbox-mapbox.readthedocs-hosted.com/en/latest/

Installation
============

.. code:: bash

    $ pip install mapbox

Testing
=======

.. code:: bash

    pip install -e .[test]
    python -m pytest

To run the examples as integration tests on your own Mapbox account

.. code:: bash

    MAPBOX_ACCESS_TOKEN="MY_ACCESS_TOKEN" python -m pytest --doctest-glob='*.md' docs/*.md

See Also
========

* Mapbox API Documentation: https://www.mapbox.com/api-documentation/
* Javascript SDK: https://github.com/mapbox/mapbox-sdk-js
* Mapbox API command line interface: https://github.com/mapbox/mapbox-cli-py


