Python Client for Google Maps Services

Description

Use Python? Want to geocode something? Looking for directions? Maybe matrices of directions? This library brings the Google Maps API Web Services to your Python application.

The Python Client for Google Maps Services is a Python Client library for the following Google Maps APIs:

Keep in mind that the same terms and conditions apply to usage of the APIs when they're accessed through this library.

Support

This library is community supported. We're comfortable enough with the stability and features of the library that we want you to build real production applications on it. We will make an effort to support the public and protected surface of the library and maintain backwards compatibility in the future; however, while the library is in version 0.x, we reserve the right to make backwards-incompatible changes. If we do remove some functionality (typically because better functionality exists or if the feature proved infeasible), our intention is to deprecate and provide ample time for developers to update their code.

If you find a bug, or have a feature suggestion, please log an issue. If you'd like to contribute, please read How to Contribute.

Requirements

Python 2.7 or later.
A Google Maps API key.

API keys

Each Google Maps Web Service requires an API key or Client ID. API keys are freely available with a Google Account at https://developers.google.com/console. To generate a server key for your project:

Visit https://developers.google.com/console and log in with a Google Account.
Select an existing project, or create a new project.
Click Enable an API.
Browse for the API, and set its status to "On". The Python Client for Google Maps Services accesses the following APIs:
- Directions API
- Distance Matrix API
- Elevation API
- Geocoding API
- Time Zone API
Once you've enabled the APIs, click Credentials from the left navigation of the Developer Console.
In the "Public API access", click Create new Key.
Choose Server Key.
If you'd like to restrict requests to a specific IP address, do so now.
Click Create.

Your API key should be 40 characters long, and begin with AIza.

Important: This key should be kept secret on your server.

Installation

$ pip install -U googlemaps

Note that you will need requests 2.4.0 or higher if you want to specify connect/read timeouts.

Developer Documentation

View the reference documentation

Additional documentation for the included web services is available at https://developers.google.com/maps/.

Usage

This example uses the Geocoding API.

gmaps = googlemaps.Client(key='Add Your Key here')

# Geocoding and address
geocode_result = gmaps.geocode('1600 Amphitheatre Parkway, Mountain View, CA')

# Look up an address with reverse geocoding
reverse_geocode_result = gmaps.reverse_geocode((40.714224, -73.961452))

# Request directions via public transit
now = datetime.now()
directions_result = gmaps.directions("Sydney Town Hall",
                                     "Parramatta, NSW",
                                     mode="transit",
                                     departure_time=now)

For more usage examples, check out the tests.

Features

Retry on Failure

Automatically retry when intermittent failures occur. That is, when any of the retriable 5xx errors are returned from the API.

Keys and Client IDs

Maps API for Work customers can use their client ID and secret to authenticate. Free customers can use their API key, too.

Building the Project

Note: You will need an API key or Client ID to run the tests.

# Installing tox
$ pip install tox

# Running tests
$ tox

# Generating documentation
$ tox -e docs

# Uploading a new release
$ easy_install wheel twine
$ python setup.py sdist bdist_wheel
$ twine upload dist/*

# Copy docs to gh-pages
$ tox -e docs && mv docs/_build/html generated_docs && git clean -Xdi && git checkout gh-pages

vhagerty / google-maps-services-python