Skip to content

Commit 3ac0a95

Browse files
committed
chore: update README per template
1 parent 9ec69cb commit 3ac0a95

1 file changed

Lines changed: 83 additions & 71 deletions

File tree

README.md

Lines changed: 83 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,46 @@
1-
Python Client for Google Maps Services
2-
====================================
3-
4-
![Test](https://github.com/googlemaps/google-maps-services-js/workflows/Test/badge.svg)
5-
![Release](https://github.com/googlemaps/google-maps-services-js/workflows/Release/badge.svg)
1+
[![PyPI](https://img.shields.io/pypi/v/googlemaps.svg)](https://pypi.python.org/pypi/googlemaps)
2+
![Release](https://github.com/googlemaps/google-maps-services-python/workflows/Release/badge.svg)
3+
![Stable](https://img.shields.io/badge/stability-stable-green)
4+
[![Tests/Build Status](https://github.com/googlemaps/google-maps-services-python/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/google-maps-services-python/actions/workflows/test.yml)
65
[![codecov](https://codecov.io/gh/googlemaps/google-maps-services-python/branch/master/graph/badge.svg)](https://codecov.io/gh/googlemaps/google-maps-services-python)
7-
[![PyPI version](https://badge.fury.io/py/googlemaps.svg)](https://badge.fury.io/py/googlemaps)
8-
![PyPI - Downloads](https://img.shields.io/pypi/dd/googlemaps)
9-
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/google-maps-services-python)
10-
11-
## Description
126

13-
Use Python? Want to geocode something? Looking for directions?
14-
Maybe matrices of directions? This library brings the Google Maps Platform Web
15-
Services to your Python application.
7+
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/google-maps-services-python?color=green)
8+
[![GitHub License](https://img.shields.io/github/license/googlemaps/google-maps-services-python?color=blue)][license]
9+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
10+
[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
1611

17-
The Python Client for Google Maps Services is a Python Client library for the following Google Maps
18-
APIs:
12+
# Python Client for Google Maps Services
1913

20-
- Directions API
21-
- Distance Matrix API
22-
- Elevation API
23-
- Geocoding API
24-
- Geolocation API
25-
- Time Zone API
26-
- Roads API
27-
- Places API
28-
- Maps Static API
29-
- Address Validation API
30-
31-
Keep in mind that the same [terms and conditions](https://developers.google.com/maps/terms) apply
32-
to usage of the APIs when they're accessed through this library.
33-
34-
## Support
14+
## Description
3515

36-
This library is community supported. We're comfortable enough with the stability and features of
37-
the library that we want you to build real production applications on it. We will try to support,
38-
through Stack Overflow, the public and protected surface of the library and maintain backwards
39-
compatibility in the future; however, while the library is in version 0.x, we reserve the right
40-
to make backwards-incompatible changes. If we do remove some functionality (typically because
41-
better functionality exists or if the feature proved infeasible), our intention is to deprecate
42-
and give developers a year to update their code.
16+
Use Python? Want to [geocode][Geocoding API] something? Looking for [directions][Directions API]? This client library brings the following [Google Maps Web Services APIs] to your server-side Python applications:
4317

44-
If you find a bug, or have a feature suggestion, please log an issue. If you'd like to
45-
contribute, please read contribute.
18+
- [Maps Static API]
19+
- [Directions API]
20+
- [Distance Matrix API]
21+
- [Elevation API]
22+
- [Geocoding API]
23+
- [Places API]
24+
- [Roads API]
25+
- [Time Zone API]
26+
TODO ? Geolocation API
27+
TODO ? Address Validation API
4628

4729
## Requirements
4830

49-
- Python 3.5 or later.
50-
- A Google Maps API key.
31+
* [Sign up with Google Maps Platform]
32+
* A Google Maps Platform [project] with the desired API(s) from the above list enabled
33+
* An [API key] associated with the project above
34+
* Python 3.5+
5135

52-
## API Keys
36+
## API Key Security
5337

54-
Each Google Maps Web Service request requires an API key or client ID. API keys
55-
are generated in the 'Credentials' page of the 'APIs & Services' tab of [Google Cloud console](https://console.cloud.google.com/apis/credentials).
38+
This client library is designed for use in server-side applications.
5639

57-
For even more information on getting started with Google Maps Platform and generating/restricting an API key, see [Get Started with Google Maps Platform](https://developers.google.com/maps/gmp-get-started) in our docs.
40+
In either case, it is important to add [API key restrictions](https://developers.google.com/maps/api-security-best-practices#restricting-api-keys) to improve its security. Additional security measures, such as hiding your key
41+
from version control, should also be put in place to further improve the security of your API key.
5842

59-
**Important:** This key should be kept secret on your server.
43+
Check out the [API Security Best Practices](https://developers.google.com/maps/api-security-best-practices) guide to learn more.
6044

6145
## Installation
6246

@@ -72,7 +56,7 @@ This example uses the Geocoding API and the Directions API with an API key:
7256
import googlemaps
7357
from datetime import datetime
7458

75-
gmaps = googlemaps.Client(key='Add Your Key here')
59+
gmaps = googlemaps.Client(key='YOUR_API_KEY')
7660

7761
# Geocoding an address
7862
geocode_result = gmaps.geocode('1600 Amphitheatre Parkway, Mountain View, CA')
@@ -107,10 +91,8 @@ For more usage examples, check out [the tests](https://github.com/googlemaps/goo
10791
Automatically retry when intermittent failures occur. That is, when any of the retriable 5xx errors
10892
are returned from the API.
10993

110-
11194
## Building the Project
11295

113-
11496
# Installing nox
11597
$ pip install nox
11698

@@ -123,28 +105,58 @@ are returned from the API.
123105
# Copy docs to gh-pages
124106
$ nox -e docs && mv docs/_build/html generated_docs && git clean -Xdi && git checkout gh-pages
125107

126-
## Documentation & resources
108+
## Documentation
109+
110+
For more information, see the reference [documentation].
111+
112+
## Contributing
127113

128-
[Documentation for the `google-maps-services-python` library](https://googlemaps.github.io/google-maps-services-python/docs/index.html)
114+
Contributions are welcome and encouraged! If you'd like to contribute, send us a [pull request] and refer to our [code of conduct] and [contributing guide].
115+
116+
## Terms of Service
117+
118+
This library uses Google Maps Platform services. Use of Google Maps Platform services through this library is subject to the Google Maps Platform [Terms of Service].
119+
120+
This library is not a Google Maps Platform Core Service. Therefore, the Google Maps Platform Terms of Service (e.g. Technical Support Services, Service Level Agreements, and Deprecation Policy) do not apply to the code in this library.
121+
122+
## Support
123+
124+
This library is offered via an open source [license]. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines, the SLA, or the [Deprecation Policy]. However, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service.
125+
126+
This library adheres to [semantic versioning] to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time.
127+
128+
If you find a bug, or have a feature request, please [file an issue] on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our [developer community channels]. If you'd like to contribute, please check the [contributing guide].
129+
130+
You can also discuss this library on our [Discord server].
129131

130-
### Getting started
131132
- [Get Started with Google Maps Platform](https://developers.google.com/maps/gmp-get-started)
132-
- [Generating/restricting an API key](https://developers.google.com/maps/gmp-get-started#api-key)
133-
- [Authenticating with a client ID](https://developers.google.com/maps/documentation/directions/get-api-key#client-id)
134-
135-
### API docs
136-
- [Google Maps Platform web services](https://developers.google.com/maps/apis-by-platform#web_service_apis)
137-
- [Directions API](https://developers.google.com/maps/documentation/directions/)
138-
- [Distance Matrix API](https://developers.google.com/maps/documentation/distancematrix/)
139-
- [Elevation API](https://developers.google.com/maps/documentation/elevation/)
140-
- [Geocoding API](https://developers.google.com/maps/documentation/geocoding/)
141-
- [Geolocation API](https://developers.google.com/maps/documentation/geolocation/)
142-
- [Time Zone API](https://developers.google.com/maps/documentation/timezone/)
143-
- [Roads API](https://developers.google.com/maps/documentation/roads/)
144-
- [Places API](https://developers.google.com/places/)
145-
- [Maps Static API](https://developers.google.com/maps/documentation/maps-static/)
146-
147-
### Support
148-
- [Report an issue](https://github.com/googlemaps/google-maps-services-python/issues)
149-
- [Contribute](https://github.com/googlemaps/google-maps-services-python/blob/master/CONTRIB.md)
150-
- [StackOverflow](http://stackoverflow.com/questions/tagged/google-maps)
133+
134+
[Google Maps Platform Web Services APIs]: https://developers.google.com/maps/apis-by-platform#web_service_apis
135+
[Maps Static API]: https://developers.google.com/maps/documentation/maps-static
136+
[Directions API]: https://developers.google.com/maps/documentation/directions
137+
[Distance Matrix API]: https://developers.google.com/maps/documentation/distancematrix
138+
[Elevation API]: https://developers.google.com/maps/documentation/elevation
139+
[Geocoding API]: https://developers.google.com/maps/documentation/geocoding
140+
[Places API]: https://developers.google.com/places/web-service
141+
[Roads API]: https://developers.google.com/maps/documentation/roads
142+
[Time Zone API]: https://developers.google.com/maps/documentation/timezone
143+
[Geolocation API]: https://developers.google.com/maps/documentation/geolocation
144+
145+
[API key]: https://developers.google.com/maps/documentation/javascript/get-api-key
146+
[documentation]: https://googlemaps.github.io/google-maps-services-python/docs
147+
148+
[code of conduct]: CODE_OF_CONDUCT.md
149+
[contributing guide]: CONTRIB.md
150+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
151+
[developer community channels]: https://developers.google.com/maps/developer-community
152+
[Discord server]: https://discord.gg/hYsWbmk
153+
[file an issue]: https://github.com/googlemaps/google-maps-services-python/issues/new/choose
154+
[license]: LICENSE
155+
[pull request]: https://github.com/googlemaps/google-maps-services-python/compare
156+
[project]: https://developers.google.com/maps/documentation/javascript/cloud-setup#enabling-apis
157+
[semantic versioning]: https://semver.org
158+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
159+
[similar inquiry]: https://github.com/googlemaps/google-maps-services-python/issues
160+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
161+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
162+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)