-
Notifications
You must be signed in to change notification settings - Fork 1.3k
chore: update README per template #535
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
wescpy
wants to merge
4
commits into
master
Choose a base branch
from
wescpy
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,47 @@ | ||
| Python Client for Google Maps Services | ||
| ==================================== | ||
| [](https://pypi.python.org/pypi/googlemaps) | ||
|  | ||
|  | ||
| [](https://github.com/googlemaps/google-maps-services-python/actions/workflows/test.yml) | ||
|
|
||
|  | ||
|  | ||
| [](https://codecov.io/gh/googlemaps/google-maps-services-python) | ||
| [](https://badge.fury.io/py/googlemaps) | ||
|  | ||
|  | ||
|
|
||
| ## 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: | ||
|  | ||
| [][license] | ||
| [](https://stackoverflow.com/questions/tagged/google-maps) | ||
| [][Discord server] | ||
|
|
||
| - Directions API | ||
| - Distance Matrix API | ||
| - Elevation API | ||
| - Geocoding API | ||
| - Geolocation API | ||
| - Time Zone API | ||
| - Roads API | ||
| - Places API | ||
| - Maps Static API | ||
| - Address Validation API | ||
| # Python Client for Google Maps Services | ||
|
|
||
| Keep in mind that the same [terms and conditions](https://developers.google.com/maps/terms) apply | ||
| to usage of the APIs when they're accessed through this library. | ||
|
|
||
| ## Support | ||
| ## Description | ||
|
|
||
| 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. | ||
| 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: | ||
|
|
||
| If you find a bug, or have a feature suggestion, please log an issue. If you'd like to | ||
| contribute, please read contribute. | ||
| - [Maps Static API] | ||
| - [Directions API] | ||
| - [Distance Matrix API] | ||
| - [Elevation API] | ||
| - [Geocoding API] | ||
| - [Places API] | ||
| - [Roads API] | ||
| - [Time Zone API] | ||
| TODO ? Geolocation API | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. TODO here and on :28
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Related to comment I left for you in the Notes Doc... PTAL, and once resolved, I can fix then remove the TODOs. Thx! |
||
| TODO ? Address Validation API | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Python 3.5 or later. | ||
| - A Google Maps API key. | ||
| - [Sign up with Google Maps Platform] | ||
| - A Google Maps Platform [project] with the desired API(s) from the above list enabled | ||
| - An [API key] associated with the project above | ||
| - Python 3.5+ | ||
|
|
||
| ## API Keys | ||
| ## API Key Security | ||
|
|
||
| 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](https://console.cloud.google.com/apis/credentials). | ||
| This client library is designed for use in server-side applications. | ||
|
|
||
| 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. | ||
| 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 | ||
| from version control, should also be put in place to further improve the security of your API key. | ||
|
|
||
| **Important:** This key should be kept secret on your server. | ||
| Check out the [API Security Best Practices](https://developers.google.com/maps/api-security-best-practices) guide to learn more. | ||
|
|
||
| ## Installation | ||
|
|
||
|
|
@@ -72,7 +57,7 @@ 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') | ||
| gmaps = googlemaps.Client(key='YOUR_API_KEY') | ||
|
|
||
| # Geocoding an address | ||
| geocode_result = gmaps.geocode('1600 Amphitheatre Parkway, Mountain View, CA') | ||
|
|
@@ -107,10 +92,8 @@ For more usage examples, check out [the tests](https://github.com/googlemaps/goo | |
| Automatically retry when intermittent failures occur. That is, when any of the retriable 5xx errors | ||
| are returned from the API. | ||
|
|
||
|
|
||
| ## Building the Project | ||
|
|
||
|
|
||
| # Installing nox | ||
| $ pip install nox | ||
|
|
||
|
|
@@ -123,28 +106,58 @@ are returned from the API. | |
| # Copy docs to gh-pages | ||
| $ nox -e docs && mv docs/_build/html generated_docs && git clean -Xdi && git checkout gh-pages | ||
|
|
||
| ## Documentation & resources | ||
| ## Documentation | ||
|
|
||
| For more information, see the reference [documentation]. | ||
|
|
||
| ## Contributing | ||
|
|
||
| [Documentation for the `google-maps-services-python` library](https://googlemaps.github.io/google-maps-services-python/docs/index.html) | ||
| 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]. | ||
|
|
||
| ## Terms of Service | ||
|
|
||
| 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]. | ||
|
|
||
| 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. | ||
|
|
||
| ## Support | ||
|
|
||
| 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. | ||
wescpy marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
|
|
||
| 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]. | ||
|
|
||
| You can also discuss this library on our [Discord server]. | ||
|
|
||
| ### Getting started | ||
| - [Get Started with Google Maps Platform](https://developers.google.com/maps/gmp-get-started) | ||
| - [Generating/restricting an API key](https://developers.google.com/maps/gmp-get-started#api-key) | ||
| - [Authenticating with a client ID](https://developers.google.com/maps/documentation/directions/get-api-key#client-id) | ||
|
|
||
| ### API docs | ||
| - [Google Maps Platform web services](https://developers.google.com/maps/apis-by-platform#web_service_apis) | ||
| - [Directions API](https://developers.google.com/maps/documentation/directions/) | ||
| - [Distance Matrix API](https://developers.google.com/maps/documentation/distancematrix/) | ||
| - [Elevation API](https://developers.google.com/maps/documentation/elevation/) | ||
| - [Geocoding API](https://developers.google.com/maps/documentation/geocoding/) | ||
| - [Geolocation API](https://developers.google.com/maps/documentation/geolocation/) | ||
| - [Time Zone API](https://developers.google.com/maps/documentation/timezone/) | ||
| - [Roads API](https://developers.google.com/maps/documentation/roads/) | ||
| - [Places API](https://developers.google.com/places/) | ||
| - [Maps Static API](https://developers.google.com/maps/documentation/maps-static/) | ||
|
|
||
| ### Support | ||
| - [Report an issue](https://github.com/googlemaps/google-maps-services-python/issues) | ||
| - [Contribute](https://github.com/googlemaps/google-maps-services-python/blob/master/CONTRIB.md) | ||
| - [StackOverflow](http://stackoverflow.com/questions/tagged/google-maps) | ||
|
|
||
| [Google Maps Platform Web Services APIs]: https://developers.google.com/maps/apis-by-platform#web_service_apis | ||
| [Maps Static API]: https://developers.google.com/maps/documentation/maps-static | ||
| [Directions API]: https://developers.google.com/maps/documentation/directions | ||
| [Distance Matrix API]: https://developers.google.com/maps/documentation/distancematrix | ||
| [Elevation API]: https://developers.google.com/maps/documentation/elevation | ||
| [Geocoding API]: https://developers.google.com/maps/documentation/geocoding | ||
| [Places API]: https://developers.google.com/places/web-service | ||
| [Roads API]: https://developers.google.com/maps/documentation/roads | ||
| [Time Zone API]: https://developers.google.com/maps/documentation/timezone | ||
| [Geolocation API]: https://developers.google.com/maps/documentation/geolocation | ||
|
|
||
| [API key]: https://developers.google.com/maps/documentation/javascript/get-api-key | ||
| [documentation]: https://googlemaps.github.io/google-maps-services-python/docs | ||
|
|
||
| [code of conduct]: ?tab=coc-ov-file#readme | ||
| [contributing guide]: CONTRIB.md | ||
| [Deprecation Policy]: https://cloud.google.com/maps-platform/terms | ||
| [developer community channels]: https://developers.google.com/maps/developer-community | ||
| [Discord server]: https://discord.gg/hYsWbmk | ||
| [file an issue]: https://github.com/googlemaps/google-maps-services-python/issues/new/choose | ||
| [license]: LICENSE | ||
| [pull request]: https://github.com/googlemaps/google-maps-services-python/compare | ||
| [project]: https://developers.google.com/maps/documentation/javascript/cloud-setup#enabling-apis | ||
| [semantic versioning]: https://semver.org | ||
| [Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start | ||
| [similar inquiry]: https://github.com/googlemaps/google-maps-services-python/issues | ||
| [SLA]: https://cloud.google.com/maps-platform/terms/sla | ||
| [Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg | ||
| [Terms of Service]: https://cloud.google.com/maps-platform/terms | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.