• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Google API Client
2
3[![PyPI version](https://badge.fury.io/py/google-api-python-client.svg)](https://badge.fury.io/py/google-api-python-client)
4
5This is the Python client library for Google's discovery based APIs. To get started, please see the [docs folder](docs/README.md).
6
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
9## Documentation
10
11See the [docs folder](docs/README.md) for more detailed instructions and additional documentation.
12
13## Google Cloud Platform / Google Ads
14
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/).
18
19## Installation
20
21Install 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.
24
25With 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
36```
37
38### Windows
39
40```
41pip install virtualenv
42virtualenv <your-env>
43<your-env>\Scripts\activate
44<your-env>\Scripts\pip.exe install google-api-python-client
45```
46
47## Supported Python Versions
48
49Python 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
51## Deprecated Python Versions
52
53Python == 2.7
54
55## Third Party Libraries and Dependencies
56
57The following libraries will be installed when you install the client library:
58* [httplib2](https://github.com/httplib2/httplib2)
59* [uritemplate](https://github.com/sigmavirus24/uritemplate)
60
61For development you will also need the following libraries:
62* [WebTest](http://webtest.pythonpaste.org/en/latest/index.html)
63* [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL)
64
65## Contributing
66
67Please 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.
68