aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Mattioli <mattiolimichael@gmail.com>2014-08-01 21:37:56 -0400
committerMichael Mattioli <mattiolimichael@gmail.com>2014-08-01 21:37:56 -0400
commit460a4adf27cc6ad5a4a2dfc0aa62d1cd9b273747 (patch)
tree5065bb382556e04b9fc978ae304e9ba553e83569 /README.md
parent13469bb17a1a09324005aabb8076b6dc426a3e65 (diff)
downloadgoogle-api-python-client-460a4adf27cc6ad5a4a2dfc0aa62d1cd9b273747.tar.gz
Updated Documentation
Removed FAQ.md as it didn’t really serve much of a purpose; the information it provides was consolidated into README.md Updated README.md to reflect development dependencies, minor spacing issue, and provide link that was previously included in FAQ.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index f6a96d2b9..b460bfb8a 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,21 @@
# About
-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).
+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.
# Installation
To install, simply use `pip` or `easy_install`:
```bash
- $ pip install --upgrade google-api-python-client
+$ pip install --upgrade google-api-python-client
```
or
```bash
- $ easy_install --upgrade google-api-python-client
+$ easy_install --upgrade google-api-python-client
```
See the [Developers Guide](https://developers.google.com/api-client-library/python/start/get_started) for more detailed instructions and additional documentation.
-# Third Party Libraries
+# Third Party Libraries and Dependencies
The following libraries will be installed when you install the client library:
* [httplib2](https://github.com/jcgregorio/httplib2)
* [uri-templates](https://github.com/uri-templates/uritemplate-py)
@@ -23,8 +23,10 @@ The following libraries will be installed when you install the client library:
Depending on your version of Python, these libraries may also be installed:
* [simplejson](https://pypi.python.org/pypi/simplejson/)
-For development you will also need:
+For development you will also need the following libraries:
* [WebTest](http://pythonpaste.org/webtest/)
+* [pycrypto](https://pypi.python.org/pypi/pycrypto)
+* [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL)
# Contributing
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. \ No newline at end of file