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