This library is essentially an async "wrapper" (not really wrapping anything, but not sure what better term to use) of the google-maps-services-python library
It includes all APIs used in google-maps-services-python
- Directions API
- Distance Matrix API
- Elevation API
- Geocoding API
- Geolocation API
- Time Zone API
- Roads API
- Places API
- Maps Static API
- At time of writing, aiohttp is used for making asynchronous http requests
and (for now) can't be substituted.
- When creating the
async_googlemaps.AsyncClientobject, anaiohttp.ClientSessionobject is a required argument. - The synchronous
googlemaps.Clienthas an optional parameter,requests_session, which is the synchronous version. - It's required here because (to my knowledge) there's no way to (internally) ensure the async client can be properly closed before the event-loop is closed, therefore it must be handled on the user's end.
- If you're unfamiliar with
aiohttp, you should go read the Client quickstart guide in the aiohttp docs - See Usage for details
- When creating the
- Python 3.5 or later.
- A Google Maps API key.
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.
$ pip install -U async_googlemaps
There are basically two ways to create the async_googlemaps.AsyncClient
These examples use the Geocoding API and the Directions API with an API key:
- ('Preferred' usage) Use an async context manager for the
aiohttp.ClientSessionthat will be passed to theasync_googlemaps.AsyncClient
from async_googlemaps import AsyncClient
import aiohttp
from datetime import datetime
async def main():
async with aiohttp.ClientSession() as maps_session:
gmaps = AsyncClient(maps_session, key='Add Your Key here')
# Then use the APIs just as you would with the synchronous version,
# but with an await keyword prefacing the method
# Geocoding an address
geocode_result = await gmaps.geocode('1600 Amphitheatre Parkway, Mountain View, CA')
# Look up an address with reverse geocoding
reverse_geocode_result = await gmaps.reverse_geocode((40.714224, -73.961452))
# Request directions via public transit
now = datetime.now()
directions_result = await gmaps.directions("Sydney Town Hall",
"Parramatta, NSW",
mode="transit",
departure_time=now)- (More flexible) Create your
aiohttp.ClientSessionobject without a context-manager, and manually close the ClientSession.
from async_googlemaps import AsyncClient
import aiohttp
async def main():
session = aiohttp.ClientSession()
gmaps = AsyncClient(session, key='Add Your Key here')
# Geocoding an address
geocode_result = await gmaps.geocode('1600 Amphitheatre Parkway, Mountain View, CA')
reverse_geocode_result = await gmaps.reverse_geocode((40.714224, -73.961452))
# aio_client must be closed manually
await session.close()Automatically retry when intermittent failures occur. That is, when any of the retriable 5xx errors are returned from the API.