Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8325d24acaa2b2077acaaea26ea5fafb6dd856c5 / . / README.md
blob: ff244866dd2293e16ca7ca8f5c812788fd77a792 [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)
4
Bu Sun Kimc9773042019-07-17 14:03:17 -0700[diff] [blame]5This is the Python client library for Google's discovery based APIs. To get started, please see the [docs folder](docs/README.md).
John Asmuth2fefc4c2014-04-24 16:13:05 -0400[diff] [blame]6
Matt Whisenhunt3c2c8052018-04-13 10:03:46 -0700[diff] [blame]7These 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.
8
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]9## Documentation
10
11See the [docs folder](docs/README.md) for more detailed instructions and additional documentation.
12
Kamil Breguła41144852020-03-20 22:42:50 +0100[diff] [blame]13## Other Google API libraries
Matt Whisenhunt3c2c8052018-04-13 10:03:46 -0700[diff] [blame]14
Kamil Breguła4c84c2c2020-01-27 18:10:19 +0100[diff] [blame]15For 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).
16
17For Google Ads API, we recommend using [Google Ads API Client Library for Python](https://github.com/googleads/google-ads-python/).
Joe Gregorio8097e2a2011-05-17 11:11:34 -0400[diff] [blame]18
Kamil Breguła41144852020-03-20 22:42:50 +0100[diff] [blame]19For Google Firebase Admin API, we recommend using [Firebase Admin Python SDK](https://github.com/firebase/firebase-admin-python).
20
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]21## Installation
22
Bu Sun Kime85af682019-10-22 13:45:38 -0700[diff] [blame]23Install this library in a [virtualenv](https://virtualenv.pypa.io/en/latest/) using pip. virtualenv is a tool to
24create isolated Python environments. The basic problem it addresses is one of
25dependencies and versions, and indirectly permissions.
Joe Gregorio46675d22012-06-20 12:15:24 -0400[diff] [blame]26
Bu Sun Kime85af682019-10-22 13:45:38 -0700[diff] [blame]27With virtualenv, it's possible to install this library without needing system
28install permissions, and without clashing with the installed system
29dependencies.
30
31### Mac/Linux
32
33```
34pip install virtualenv
35virtualenv <your-env>
36source <your-env>/bin/activate
37<your-env>/bin/pip install google-api-python-client
Michael Mattiolib2b518f2014-07-14 00:48:04 -0400[diff] [blame]38```
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]39
Bu Sun Kime85af682019-10-22 13:45:38 -0700[diff] [blame]40### Windows
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]41
Bu Sun Kime85af682019-10-22 13:45:38 -0700[diff] [blame]42```
43pip install virtualenv
44virtualenv <your-env>
45<your-env>\Scripts\activate
46<your-env>\Scripts\pip.exe install google-api-python-client
Michael Mattiolib2b518f2014-07-14 00:48:04 -0400[diff] [blame]47```
Tom Miller7c95d812010-10-11 11:50:52 -0700[diff] [blame]48
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]49## Supported Python Versions
Joe Gregorio48d361f2010-08-18 13:19:21 -0400[diff] [blame]50
Bu Sun Kim8325d242020-12-09 12:04:05 -0700[diff] [blame^]51Python 3.6, 3.7, 3.8, and 3.9 are fully supported and tested. This library may work on later versions of 3, but we do not currently run tests against those versions.
Christopher Wilcox8f4a5302018-12-14 12:24:44 -0800[diff] [blame]52
Bu Sun Kim8325d242020-12-09 12:04:05 -0700[diff] [blame^]53## Unsupported Python Versions
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]54
Bu Sun Kim8325d242020-12-09 12:04:05 -0700[diff] [blame^]55Python < 3.6
Jay Lee9cd0eb02014-09-12 07:15:11 -0400[diff] [blame]56
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]57## Third Party Libraries and Dependencies
58
Michael Mattiolib2b518f2014-07-14 00:48:04 -0400[diff] [blame]59The following libraries will be installed when you install the client library:
Luis Nell4859b142016-08-01 18:43:35 +0200[diff] [blame]60* [httplib2](https://github.com/httplib2/httplib2)
Simon Weberc952fd02016-10-13 12:48:44 -0400[diff] [blame]61* [uritemplate](https://github.com/sigmavirus24/uritemplate)
Joe Gregorio8097e2a2011-05-17 11:11:34 -0400[diff] [blame]62
Michael Mattioli460a4ad2014-08-01 21:37:56 -0400[diff] [blame]63For development you will also need the following libraries:
andrewnester31677812017-03-31 16:39:30 +0300[diff] [blame]64* [WebTest](http://webtest.pythonpaste.org/en/latest/index.html)
Michael Mattioli460a4ad2014-08-01 21:37:56 -0400[diff] [blame]65* [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL)
Craig Citro3f8dc782014-05-19 15:00:07 -0700[diff] [blame]66
Grant Timmerman5c11b0a2019-06-26 07:39:48 -0700[diff] [blame]67## Contributing
68
Dmitry Frenkel63f97f32020-07-09 10:14:02 -0700[diff] [blame]69Please see our [Contribution Guide](CONTRIBUTING.rst).
70In particular, we love pull requests - but please make sure to sign
71the contributor license agreement.