aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGrant Timmerman <timmerman+devrel@google.com>2019-06-26 07:39:48 -0700
committerBu Sun Kim <8822365+busunkim96@users.noreply.github.com>2019-06-26 07:39:48 -0700
commit5c11b0a1b2658b26fe41b13ebd2e9e7b53c1ab01 (patch)
tree152d837a399eba853d2d8a44cba19a74912c52d6 /README.md
parent715bd7f9ca9a324a05ee05a6476af383e54930f9 (diff)
downloadgoogle-api-python-client-5c11b0a1b2658b26fe41b13ebd2e9e7b53c1ab01.tar.gz
docs: Add docs folder with guides from developers.google.com
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 17 insertions, 8 deletions
diff --git a/README.md b/README.md
index 8d4c426b6..8a1f4f25d 100644
--- a/README.md
+++ b/README.md
@@ -8,30 +8,38 @@ This is the Python client library for Google's discovery based APIs. To get star
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.
+## Documentation
+
+See the [docs folder](docs/README.md) for more detailed instructions and additional documentation.
+
## Google Cloud Platform
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.
-# Installation
+## 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.
+## Supported Python Versions
-# Supported Python Versions
Python 3.4, 3.5, 3.6 and 3.7 are fully supported and tested. This library may work on later versions of 3, but we do not currently run tests against those versions
-# Deprecated Python Versions
+## Deprecated Python Versions
+
Python == 2.7
-# Third Party Libraries and Dependencies
+## Third Party Libraries and Dependencies
+
The following libraries will be installed when you install the client library:
* [httplib2](https://github.com/httplib2/httplib2)
* [uritemplate](https://github.com/sigmavirus24/uritemplate)
@@ -41,5 +49,6 @@ For development you will also need the following libraries:
* [pycrypto](https://pypi.python.org/pypi/pycrypto)
* [pyopenssl](https://pypi.python.org/pypi/pyOpenSSL)
-# Contributing
+## 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.