| Matt Whisenhunt | 3c2c805 | 2018-04-13 10:03:46 -0700 | [diff] [blame] | 1 | # Google API Client |
| Dan O'Meara | 9c203d3 | 2017-07-07 09:03:31 -0700 | [diff] [blame] | 2 | |
| Chris McDonough | c7533a0 | 2018-07-17 13:31:48 -0400 | [diff] [blame^] | 3 | This 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 Asmuth | 2fefc4c | 2014-04-24 16:13:05 -0400 | [diff] [blame] | 4 | |
| Matt Whisenhunt | 3c2c805 | 2018-04-13 10:03:46 -0700 | [diff] [blame] | 5 | These 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. |
| 6 | |
| 7 | ## Google Cloud Platform |
| 8 | |
| 9 | For 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 Gregorio | 8097e2a | 2011-05-17 11:11:34 -0400 | [diff] [blame] | 10 | |
| Michael Mattioli | 2b2705a | 2014-07-14 13:52:54 -0400 | [diff] [blame] | 11 | # Installation |
| Craig Citro | 3f8dc78 | 2014-05-19 15:00:07 -0700 | [diff] [blame] | 12 | To install, simply use `pip` or `easy_install`: |
| Joe Gregorio | 46675d2 | 2012-06-20 12:15:24 -0400 | [diff] [blame] | 13 | |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 14 | ```bash |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 15 | $ pip install --upgrade google-api-python-client |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 16 | ``` |
| Craig Citro | 4cc527f | 2014-05-19 15:01:17 -0700 | [diff] [blame] | 17 | or |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 18 | ```bash |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 19 | $ easy_install --upgrade google-api-python-client |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 20 | ``` |
| Tom Miller | 7c95d81 | 2010-10-11 11:50:52 -0700 | [diff] [blame] | 21 | |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 22 | See the [Developers Guide](https://developers.google.com/api-client-library/python/start/get_started) for more detailed instructions and additional documentation. |
| Joe Gregorio | 48d361f | 2010-08-18 13:19:21 -0400 | [diff] [blame] | 23 | |
| Jay Lee | 9cd0eb0 | 2014-09-12 07:15:11 -0400 | [diff] [blame] | 24 | # Python Version |
| Jon Wayne Parrott | 12751ca | 2017-01-31 09:21:36 -0800 | [diff] [blame] | 25 | Python 2.7, 3.4, 3.5, and 3.6 are fully supported and tested. This library may work on later versions of 3, but we do not currently run tests against those versions. |
| Jay Lee | 9cd0eb0 | 2014-09-12 07:15:11 -0400 | [diff] [blame] | 26 | |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 27 | # Third Party Libraries and Dependencies |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 28 | The following libraries will be installed when you install the client library: |
| Luis Nell | 4859b14 | 2016-08-01 18:43:35 +0200 | [diff] [blame] | 29 | * [httplib2](https://github.com/httplib2/httplib2) |
| Simon Weber | c952fd0 | 2016-10-13 12:48:44 -0400 | [diff] [blame] | 30 | * [uritemplate](https://github.com/sigmavirus24/uritemplate) |
| Joe Gregorio | 8097e2a | 2011-05-17 11:11:34 -0400 | [diff] [blame] | 31 | |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 32 | For development you will also need the following libraries: |
| andrewnester | 3167781 | 2017-03-31 16:39:30 +0300 | [diff] [blame] | 33 | * [WebTest](http://webtest.pythonpaste.org/en/latest/index.html) |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 34 | * [pycrypto](https://pypi.python.org/pypi/pycrypto) |
| 35 | * [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL) |
| Craig Citro | 3f8dc78 | 2014-05-19 15:00:07 -0700 | [diff] [blame] | 36 | |
| Michael Mattioli | 2b2705a | 2014-07-14 13:52:54 -0400 | [diff] [blame] | 37 | # Contributing |
| Jay Lee | 9cd0eb0 | 2014-09-12 07:15:11 -0400 | [diff] [blame] | 38 | Please 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. |