blob: ee38961d6225ea48f9239885991a65c1922c7b40 [file] [log] [blame] [view]
Matt Whisenhunt3c2c8052018-04-13 10:03:46 -07001# Google API Client
Dan O'Meara9c203d32017-07-07 09:03:31 -07002
Sander Brauwers729d9ae2018-12-13 19:28:04 +01003[![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 -07005This 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 -04006
Matt Whisenhunt3c2c8052018-04-13 10:03:46 -07007These 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 -07009## Documentation
10
11See the [docs folder](docs/README.md) for more detailed instructions and additional documentation.
12
Kamil Breguła4c84c2c2020-01-27 18:10:19 +010013## Google Cloud Platform / Google Ads
Matt Whisenhunt3c2c8052018-04-13 10:03:46 -070014
Kamil Breguła4c84c2c2020-01-27 18:10:19 +010015For 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 -040018
Grant Timmerman5c11b0a2019-06-26 07:39:48 -070019## Installation
20
Bu Sun Kime85af682019-10-22 13:45:38 -070021Install this library in a [virtualenv](https://virtualenv.pypa.io/en/latest/) using pip. virtualenv is a tool to
22create isolated Python environments. The basic problem it addresses is one of
23dependencies and versions, and indirectly permissions.
Joe Gregorio46675d22012-06-20 12:15:24 -040024
Bu Sun Kime85af682019-10-22 13:45:38 -070025With virtualenv, it's possible to install this library without needing system
26install permissions, and without clashing with the installed system
27dependencies.
28
29### Mac/Linux
30
31```
32pip install virtualenv
33virtualenv <your-env>
34source <your-env>/bin/activate
35<your-env>/bin/pip install google-api-python-client
Michael Mattiolib2b518f2014-07-14 00:48:04 -040036```
Grant Timmerman5c11b0a2019-06-26 07:39:48 -070037
Bu Sun Kime85af682019-10-22 13:45:38 -070038### Windows
Grant Timmerman5c11b0a2019-06-26 07:39:48 -070039
Bu Sun Kime85af682019-10-22 13:45:38 -070040```
41pip install virtualenv
42virtualenv <your-env>
43<your-env>\Scripts\activate
44<your-env>\Scripts\pip.exe install google-api-python-client
Michael Mattiolib2b518f2014-07-14 00:48:04 -040045```
Tom Miller7c95d812010-10-11 11:50:52 -070046
Grant Timmerman5c11b0a2019-06-26 07:39:48 -070047## Supported Python Versions
Joe Gregorio48d361f2010-08-18 13:19:21 -040048
Christopher Wilcox8f4a5302018-12-14 12:24:44 -080049Python 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
50
Grant Timmerman5c11b0a2019-06-26 07:39:48 -070051## Deprecated Python Versions
52
Christopher Wilcox8f4a5302018-12-14 12:24:44 -080053Python == 2.7
Jay Lee9cd0eb02014-09-12 07:15:11 -040054
Grant Timmerman5c11b0a2019-06-26 07:39:48 -070055## Third Party Libraries and Dependencies
56
Michael Mattiolib2b518f2014-07-14 00:48:04 -040057The following libraries will be installed when you install the client library:
Luis Nell4859b142016-08-01 18:43:35 +020058* [httplib2](https://github.com/httplib2/httplib2)
Simon Weberc952fd02016-10-13 12:48:44 -040059* [uritemplate](https://github.com/sigmavirus24/uritemplate)
Joe Gregorio8097e2a2011-05-17 11:11:34 -040060
Michael Mattioli460a4ad2014-08-01 21:37:56 -040061For development you will also need the following libraries:
andrewnester31677812017-03-31 16:39:30 +030062* [WebTest](http://webtest.pythonpaste.org/en/latest/index.html)
Michael Mattioli460a4ad2014-08-01 21:37:56 -040063* [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL)
Craig Citro3f8dc782014-05-19 15:00:07 -070064
Grant Timmerman5c11b0a2019-06-26 07:39:48 -070065## Contributing
66
Jay Lee9cd0eb02014-09-12 07:15:11 -040067Please 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.