| Michael Mattioli | 2b2705a | 2014-07-14 13:52:54 -0400 | [diff] [blame] | 1 | # About |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 2 | This is the Python client library for Google's discovery based APIs. To get started, please see the [full documentation for this library](http://google.github.io/google-api-python-client). Additionally, [dynamically generated documentation](http://api-python-client-doc.appspot.com/) is available for all of the APIs supported by this library. |
| John Asmuth | 2fefc4c | 2014-04-24 16:13:05 -0400 | [diff] [blame] | 3 | |
| Jon Wayne Parrott | 42818cf | 2017-05-12 09:35:24 -0700 | [diff] [blame] | 4 | ## Google Cloud Platform APIs |
| 5 | If you're working with **Google Cloud Platform** APIs such as Datastore or Pub/Sub, consider using the [Cloud Client Libraries for Python](https://github.com/GoogleCloudPlatform/google-cloud-python) instead. These are the new and idiomatic Python libraries targeted specifically at Google Cloud Platform Services. |
| Joe Gregorio | 8097e2a | 2011-05-17 11:11:34 -0400 | [diff] [blame] | 6 | |
| Michael Mattioli | 2b2705a | 2014-07-14 13:52:54 -0400 | [diff] [blame] | 7 | # Installation |
| Craig Citro | 3f8dc78 | 2014-05-19 15:00:07 -0700 | [diff] [blame] | 8 | To install, simply use `pip` or `easy_install`: |
| Joe Gregorio | 46675d2 | 2012-06-20 12:15:24 -0400 | [diff] [blame] | 9 | |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 10 | ```bash |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 11 | $ pip install --upgrade google-api-python-client |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 12 | ``` |
| Craig Citro | 4cc527f | 2014-05-19 15:01:17 -0700 | [diff] [blame] | 13 | or |
| 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 | $ easy_install --upgrade google-api-python-client |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 16 | ``` |
| Tom Miller | 7c95d81 | 2010-10-11 11:50:52 -0700 | [diff] [blame] | 17 | |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 18 | 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] | 19 | |
| Jay Lee | 9cd0eb0 | 2014-09-12 07:15:11 -0400 | [diff] [blame] | 20 | # Python Version |
| Jon Wayne Parrott | 12751ca | 2017-01-31 09:21:36 -0800 | [diff] [blame] | 21 | 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] | 22 | |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 23 | # Third Party Libraries and Dependencies |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 24 | The following libraries will be installed when you install the client library: |
| Luis Nell | 4859b14 | 2016-08-01 18:43:35 +0200 | [diff] [blame] | 25 | * [httplib2](https://github.com/httplib2/httplib2) |
| Simon Weber | c952fd0 | 2016-10-13 12:48:44 -0400 | [diff] [blame] | 26 | * [uritemplate](https://github.com/sigmavirus24/uritemplate) |
| Joe Gregorio | 8097e2a | 2011-05-17 11:11:34 -0400 | [diff] [blame] | 27 | |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 28 | For development you will also need the following libraries: |
| andrewnester | 3167781 | 2017-03-31 16:39:30 +0300 | [diff] [blame] | 29 | * [WebTest](http://webtest.pythonpaste.org/en/latest/index.html) |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 30 | * [pycrypto](https://pypi.python.org/pypi/pycrypto) |
| 31 | * [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL) |
| Craig Citro | 3f8dc78 | 2014-05-19 15:00:07 -0700 | [diff] [blame] | 32 | |
| Michael Mattioli | 2b2705a | 2014-07-14 13:52:54 -0400 | [diff] [blame] | 33 | # Contributing |
| Jay Lee | 9cd0eb0 | 2014-09-12 07:15:11 -0400 | [diff] [blame] | 34 | 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. |