Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 20b67588e9a009a30ed883337dc70a43729ba486 / . / README.md
blob: 8a1f4f25dd5b6774d91523815b9db515d1ee7a06 [file] [log] [blame] [view]
Matt Whisenhunt3c2c8052018-04-13 10:03:46 -0700[diff] [blame]1# Google API Client
Dan O'Meara9c203d32017-07-07 09:03:31 -0700[diff] [blame]2
Sander Brauwers729d9ae2018-12-13 19:28:04 +0100[diff] [blame]3[![PyPI version](https://badge.fury.io/py/google-api-python-client.svg)](https://badge.fury.io/py/google-api-python-client)
ylil93d82f3e72019-06-10 11:08:14 -0700[diff] [blame]4[![Compat check PyPI](https://python-compatibility-tools.appspot.com/one_badge_image?package=google-api-python-client)](https://python-compatibility-tools.appspot.com/one_badge_target?package=google-api-python-client)
5[![Compat check github](https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-api-python-client.git)](https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-api-python-client.git)
Sander Brauwers729d9ae2018-12-13 19:28:04 +0100[diff] [blame]6
Chris McDonoughc7533a02018-07-17 13:31:48 -0400[diff] [blame]7This is the Python client library for Google's discovery based APIs. To get started, please see the [full documentation for this library](https://developers.google.com/api-client-library/python/). Additionally, [dynamically generated documentation](http://google.github.io/google-api-python-client/docs/epy/index.html) is available for all of the APIs supported by this library.
John Asmuth2fefc4c2014-04-24 16:13:05 -0400[diff] [blame]8
Matt Whisenhunt3c2c8052018-04-13 10:03:46 -0700[diff] [blame]9These client libraries are officially supported by Google. However, the libraries are considered complete and are in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.
10
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]11## Documentation
12
13See the [docs folder](docs/README.md) for more detailed instructions and additional documentation.
14
Matt Whisenhunt3c2c8052018-04-13 10:03:46 -0700[diff] [blame]15## Google Cloud Platform
16
17For Google Cloud Platform APIs such as Datastore, Cloud Storage or Pub/Sub, we recommend using [Cloud Client Libraries for Python](https://github.com/GoogleCloudPlatform/google-cloud-python) which is under active development.
Joe Gregorio8097e2a2011-05-17 11:11:34 -0400[diff] [blame]18
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]19## Installation
20
Craig Citro3f8dc782014-05-19 15:00:07 -0700[diff] [blame]21To install, simply use `pip` or `easy_install`:
Joe Gregorio46675d22012-06-20 12:15:24 -0400[diff] [blame]22
Michael Mattiolib2b518f2014-07-14 00:48:04 -0400[diff] [blame]23```bash
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]24pip install --upgrade google-api-python-client
Michael Mattiolib2b518f2014-07-14 00:48:04 -0400[diff] [blame]25```
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]26
Craig Citro4cc527f2014-05-19 15:01:17 -0700[diff] [blame]27or
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]28
Michael Mattiolib2b518f2014-07-14 00:48:04 -0400[diff] [blame]29```bash
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]30easy_install --upgrade google-api-python-client
Michael Mattiolib2b518f2014-07-14 00:48:04 -0400[diff] [blame]31```
Tom Miller7c95d812010-10-11 11:50:52 -0700[diff] [blame]32
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]33## Supported Python Versions
Joe Gregorio48d361f2010-08-18 13:19:21 -0400[diff] [blame]34
Christopher Wilcox8f4a5302018-12-14 12:24:44 -0800[diff] [blame]35Python 3.4, 3.5, 3.6 and 3.7 are fully supported and tested. This library may work on later versions of 3, but we do not currently run tests against those versions
36
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]37## Deprecated Python Versions
38
Christopher Wilcox8f4a5302018-12-14 12:24:44 -0800[diff] [blame]39Python == 2.7
Jay Lee9cd0eb02014-09-12 07:15:11 -0400[diff] [blame]40
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]41## Third Party Libraries and Dependencies
42
Michael Mattiolib2b518f2014-07-14 00:48:04 -0400[diff] [blame]43The following libraries will be installed when you install the client library:
Luis Nell4859b142016-08-01 18:43:35 +0200[diff] [blame]44* [httplib2](https://github.com/httplib2/httplib2)
Simon Weberc952fd02016-10-13 12:48:44 -0400[diff] [blame]45* [uritemplate](https://github.com/sigmavirus24/uritemplate)
Joe Gregorio8097e2a2011-05-17 11:11:34 -0400[diff] [blame]46
Michael Mattioli460a4ad2014-08-01 21:37:56 -0400[diff] [blame]47For development you will also need the following libraries:
andrewnester31677812017-03-31 16:39:30 +0300[diff] [blame]48* [WebTest](http://webtest.pythonpaste.org/en/latest/index.html)
Michael Mattioli460a4ad2014-08-01 21:37:56 -0400[diff] [blame]49* [pycrypto](https://pypi.python.org/pypi/pycrypto)
50* [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL)
Craig Citro3f8dc782014-05-19 15:00:07 -0700[diff] [blame]51
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]52## Contributing
53
Jay Lee9cd0eb02014-09-12 07:15:11 -0400[diff] [blame]54Please see the [contributing page](http://google.github.io/google-api-python-client/contributing.html) for more information. In particular, we love pull requests - but please make sure to sign the contributor license agreement.