blob: 19590c77d6c20769f73b8d8011c9cbd71894d218 [file] [log] [blame] [view]
Michael Mattioli2b2705a2014-07-14 13:52:54 -04001# About
Michael Mattioli460a4ad2014-08-01 21:37:56 -04002This 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 Asmuth2fefc4c2014-04-24 16:13:05 -04003
Joe Gregorio8097e2a2011-05-17 11:11:34 -04004
Michael Mattioli2b2705a2014-07-14 13:52:54 -04005# Installation
Craig Citro3f8dc782014-05-19 15:00:07 -07006To install, simply use `pip` or `easy_install`:
Joe Gregorio46675d22012-06-20 12:15:24 -04007
Michael Mattiolib2b518f2014-07-14 00:48:04 -04008```bash
Michael Mattioli460a4ad2014-08-01 21:37:56 -04009$ pip install --upgrade google-api-python-client
Michael Mattiolib2b518f2014-07-14 00:48:04 -040010```
Craig Citro4cc527f2014-05-19 15:01:17 -070011or
Michael Mattiolib2b518f2014-07-14 00:48:04 -040012```bash
Michael Mattioli460a4ad2014-08-01 21:37:56 -040013$ easy_install --upgrade google-api-python-client
Michael Mattiolib2b518f2014-07-14 00:48:04 -040014```
Tom Miller7c95d812010-10-11 11:50:52 -070015
Michael Mattiolib2b518f2014-07-14 00:48:04 -040016See the [Developers Guide](https://developers.google.com/api-client-library/python/start/get_started) for more detailed instructions and additional documentation.
Joe Gregorio48d361f2010-08-18 13:19:21 -040017
Jay Lee9cd0eb02014-09-12 07:15:11 -040018# Python Version
Craig Citro6de33d52015-04-15 16:10:11 -070019Python 2.6 or 2.7 are fully supported.
20
21Python 3.3+ is also now supported! However, this library has not yet been used
22as thoroughly with Python 3, so we'd recommend testing before deploying with
23Python 3 in production.
Jay Lee9cd0eb02014-09-12 07:15:11 -040024
Michael Mattioli460a4ad2014-08-01 21:37:56 -040025# Third Party Libraries and Dependencies
Michael Mattiolib2b518f2014-07-14 00:48:04 -040026The following libraries will be installed when you install the client library:
Luis Nell4859b142016-08-01 18:43:35 +020027* [httplib2](https://github.com/httplib2/httplib2)
Simon Weberc952fd02016-10-13 12:48:44 -040028* [uritemplate](https://github.com/sigmavirus24/uritemplate)
Joe Gregorio8097e2a2011-05-17 11:11:34 -040029
Michael Mattioli460a4ad2014-08-01 21:37:56 -040030For development you will also need the following libraries:
Michael Mattioli30598d62014-07-14 00:52:52 -040031* [WebTest](http://pythonpaste.org/webtest/)
Michael Mattioli460a4ad2014-08-01 21:37:56 -040032* [pycrypto](https://pypi.python.org/pypi/pycrypto)
33* [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL)
Craig Citro3f8dc782014-05-19 15:00:07 -070034
Michael Mattioli2b2705a2014-07-14 13:52:54 -040035# Contributing
Jay Lee9cd0eb02014-09-12 07:15:11 -040036Please 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.