Metadata-Version: 2.4
Name: google-maps-sdk
Version: 1.0.0
Summary: Google Maps API provides mapping, location, and navigation services, enabling developers to embed maps, routes, and place data into applications.
Author-email: Hamza Shahzad <muhammad.hamza@apimatic.io>
Project-URL: Documentation, https://docs.apimatic.io/
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: apimatic-core>=0.2.20,~=0.2.0
Requires-Dist: apimatic-core-interfaces>=0.1.5,~=0.1.0
Requires-Dist: apimatic-requests-client-adapter>=0.1.6,~=0.1.0
Provides-Extra: testutils
Requires-Dist: pytest>=7.2.2; extra == "testutils"
Dynamic: license-file


# Getting Started with Google Maps Platform – Core APIs

## Introduction

This is an API collection of all of the current Google Maps Platform Core APIs. Please visit the [Google Maps homepage](https://mapsplatform.google.com/) for more information.

## Install the Package

The package is compatible with Python versions `3.7+`.
Install the package from PyPi using the following pip command:

```bash
pip install google-maps-sdk==1.0.0
```

You can also view the package at:
https://pypi.python.org/pypi/google-maps-sdk/1.0.0

## Test the SDK

You can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `pytest` is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands


pip install -r test-requirements.txt
pytest


## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| environment | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| http_client_instance | `HttpClient` | The Http Client passed from the sdk user for making requests |
| override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
| http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
| timeout | `float` | The value to use for connection timeout. <br> **Default: 60** |
| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
| retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |
| custom_query_authentication_credentials | [`CustomQueryAuthenticationCredentials`](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/auth/custom-query-parameter.md) | The credential object for Custom Query Parameter |

The API client can be initialized as follows:

```python
from googlemapsplatformcoreapis.configuration import Environment
from googlemapsplatformcoreapis.googlemapsplatformcoreapis_client import GooglemapsplatformcoreapisClient
from googlemapsplatformcoreapis.http.auth.custom_query_authentication import CustomQueryAuthenticationCredentials

client = GooglemapsplatformcoreapisClient(
    custom_query_authentication_credentials=CustomQueryAuthenticationCredentials(
        key='key'
    ),
    environment=Environment.PRODUCTION
)
```

## Authorization

This API uses the following authentication schemes.

* [`apiKey (Custom Query Parameter)`](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/auth/custom-query-parameter.md)

## List of APIs

* [Address Validation API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/address-validation-api.md)
* [Aerial View API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/aerial-view-api.md)
* [Directions API Legacy](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/directions-api-legacy.md)
* [Distance Matrix API Legacy](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/distance-matrix-api-legacy.md)
* [Elevation API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/elevation-api.md)
* [Geocoding API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/geocoding-api.md)
* [Geolocation API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/geolocation-api.md)
* [Places API Legacy](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/places-api-legacy.md)
* [Places API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/places-api.md)
* [Roads API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/roads-api.md)
* [Routes API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/routes-api.md)
* [Street View API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/street-view-api.md)
* [Time Zone API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/time-zone-api.md)
* [Solar API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/solar-api.md)
* [Pollen API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/pollen-api.md)
* [Air Quality API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/air-quality-api.md)
* [Weather API](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/weather-api.md)
* [Autocomplete](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/controllers/autocomplete.md)

## SDK Infrastructure

### HTTP

* [HttpResponse](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/http-request.md)

### Utilities

* [ApiHelper](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/MuHamza30/google-maps-python-sdk/tree/1.0.0/doc/unix-date-time.md)

