| 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 | |
| Joe Gregorio | 8097e2a | 2011-05-17 11:11:34 -0400 | [diff] [blame] | 4 | |
| Michael Mattioli | 2b2705a | 2014-07-14 13:52:54 -0400 | [diff] [blame] | 5 | # Installation |
| Craig Citro | 3f8dc78 | 2014-05-19 15:00:07 -0700 | [diff] [blame] | 6 | To install, simply use `pip` or `easy_install`: |
| Joe Gregorio | 46675d2 | 2012-06-20 12:15:24 -0400 | [diff] [blame] | 7 | |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 8 | ```bash |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 9 | $ pip install --upgrade google-api-python-client |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 10 | ``` |
| Craig Citro | 4cc527f | 2014-05-19 15:01:17 -0700 | [diff] [blame] | 11 | or |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 12 | ```bash |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 13 | $ easy_install --upgrade google-api-python-client |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 14 | ``` |
| Tom Miller | 7c95d81 | 2010-10-11 11:50:52 -0700 | [diff] [blame] | 15 | |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 16 | 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] | 17 | |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 18 | # Third Party Libraries and Dependencies |
| Michael Mattioli | b2b518f | 2014-07-14 00:48:04 -0400 | [diff] [blame] | 19 | The following libraries will be installed when you install the client library: |
| Michael Mattioli | 30598d6 | 2014-07-14 00:52:52 -0400 | [diff] [blame] | 20 | * [httplib2](https://github.com/jcgregorio/httplib2) |
| 21 | * [uri-templates](https://github.com/uri-templates/uritemplate-py) |
| Joe Gregorio | 8097e2a | 2011-05-17 11:11:34 -0400 | [diff] [blame] | 22 | |
| 23 | Depending on your version of Python, these libraries may also be installed: |
| Michael Mattioli | 30598d6 | 2014-07-14 00:52:52 -0400 | [diff] [blame] | 24 | * [simplejson](https://pypi.python.org/pypi/simplejson/) |
| Joe Gregorio | 432f17e | 2011-05-22 23:18:00 -0400 | [diff] [blame] | 25 | |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 26 | For development you will also need the following libraries: |
| Michael Mattioli | 30598d6 | 2014-07-14 00:52:52 -0400 | [diff] [blame] | 27 | * [WebTest](http://pythonpaste.org/webtest/) |
| Michael Mattioli | 460a4ad | 2014-08-01 21:37:56 -0400 | [diff] [blame] | 28 | * [pycrypto](https://pypi.python.org/pypi/pycrypto) |
| 29 | * [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL) |
| Craig Citro | 3f8dc78 | 2014-05-19 15:00:07 -0700 | [diff] [blame] | 30 | |
| Michael Mattioli | 2b2705a | 2014-07-14 13:52:54 -0400 | [diff] [blame] | 31 | # Contributing |
| Michael Mattioli | 30598d6 | 2014-07-14 00:52:52 -0400 | [diff] [blame] | 32 | 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. |