googlemaps 3.1.2

Python client library for Google Maps Platform

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 Platform Web Services to your Python application.

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

• Directions API
• Distance Matrix API
• Elevation API
• Geocoding API
• Geolocation API
• Time Zone API
• Roads API
• Places API

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 try to support, through Stack Overflow, 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 give developers a year 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 contribute.

Requirements

• Python 2.7 or later.
• A Google Maps API key.

API Keys

Each Google Maps Web Service request requires an API key or client ID. API keys are generated in the 'Credentials' page of the 'APIs & Services' tab of Google Cloud console.

For even more information on getting started with Google Maps Platform and generating/restricting an API key, see Get Started with Google Maps Platform in our docs.

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.

Usage

This example uses the Geocoding API and the Directions API with an API key:

import googlemaps
from datetime import datetime

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

# Geocoding an 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)

Below is the same example, using client ID and client secret (digital signature) for authentication. This code assumes you have previously loaded the client_id and client_secret variables with appropriate values.

For a guide on how to generate the client_secret (digital signature), see the documentation for the API you're using. For example, see the guide for the Directions API.

gmaps = googlemaps.Client(client_id=client_id, client_secret=client_secret)

# 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.

Client IDs

Google Maps APIs Premium Plan customers can use their client ID and secret to authenticate, instead of an API key.

Building the Project

# Installing nox
$ pip install nox

# Running tests
$ nox

# Generating documentation
$ nox -e docs

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

Documentation & resources

Getting started

• Get Started with Google Maps Platform
• Generating/restricting an API key
• Authenticating with a client ID

API docs

• Google Maps Platform web services
• Directions API
• Distance Matrix API
• Elevation API
• Geocoding API
• Geolocation API
• Time Zone API
• Roads API
• Places API

Support

• Report an issue
• Contribute
• StackOverflow

Changelog

All notable changes to this project will be documented in this file.

Unreleased

Changed

Added

Removed

v3.1.2

Added

• Tests for distribution tar as part of CI
• Support for subfields such as geometry/location and geometry/viewport in Places.

v3.1.1

Changed

• Added changelog to manifest

v3.1.0

Changed

• Switched build system to use nox, pytest, and codecov. Added Python 3.7 to test framework.
• Set precision of truncated latitude and longitude floats to 8 decimals instead of 6.
• Minimum version of requests increased.
• Session token parameter added to place().
• Fixed issue where headers in request_kwargs were being overridden.

Added

• Automation for PyPi uploads.
• Long description to package.
• Added tests to manifest and tarball.

Removed

• Removed places places_autocomplete_session_token which can be replaced with uuid.uuid4().hex.
• Removed deprecated places_radar.

Note: Start of changelog is 2019-08-27, v3.0.2.