Skip to content

Commit ad632e9

Browse files
committed
Updating README to match gcloud-node.
TO do this, moving Semantic Versioning section to CONTRIBUTING document and removing the majority of the Python Versions section. The remaining parts were moved up to the Quick Start section.
1 parent a019614 commit ad632e9

File tree

2 files changed

+53
-26
lines changed

2 files changed

+53
-26
lines changed

CONTRIBUTING.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,17 @@ We also explicitly decided to support Python 3 beginning with version
343343
.. _Unicode literal support: https://www.python.org/dev/peps/pep-0414/
344344
.. _drop 2.6: https://github.com/GoogleCloudPlatform/gcloud-python/issues/995
345345

346+
Versioning
347+
----------
348+
349+
This library follows `Semantic Versioning`_.
350+
351+
.. _Semantic Versioning: http://semver.org/
352+
353+
It is currently in major version zero (``0.y.z``), which means that anything
354+
may change at any time and the public API should not be considered
355+
stable.
356+
346357
Contributor License Agreements
347358
------------------------------
348359

README.rst

Lines changed: 42 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,56 @@ This client supports the following Google Cloud Platform services:
1919
- `Google Cloud Storage`_
2020
- `Google Cloud Pub/Sub`_
2121
- `Google BigQuery`_
22+
- `Google Cloud Resource Manager`_
2223

2324
.. _Google Cloud Datastore: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-datastore
2425
.. _Google Cloud Storage: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-storage
2526
.. _Google Cloud Pub/Sub: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-pubsub
2627
.. _Google BigQuery: https://github.com/GoogleCloudPlatform/gcloud-python#google-bigquery
28+
.. _Google Cloud Resource Manager: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-resource-manager
2729

2830
If you need support for other Google APIs, check out the
2931
`Google APIs Python Client library`_.
3032

3133
.. _Google APIs Python Client library: https://github.com/google/google-api-python-client
3234

33-
Quickstart
34-
----------
35+
Quick Start
36+
-----------
3537

3638
::
3739

3840
$ pip install --upgrade gcloud
3941

42+
We support:
43+
44+
- `Python 2.6`_
45+
- `Python 2.7`_
46+
- `Python 3.3`_
47+
- `Python 3.4`_
48+
49+
For more information, see `Supported Python Versions`_ in
50+
``CONTRIBUTING``.
51+
52+
.. _Supported Python Versions: https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/CONTRIBUTING.rst#supported-python-versions
53+
4054
Example Applications
4155
--------------------
4256

4357
- `gcloud-python-expenses-demo`_ - A sample expenses demo using Cloud Datastore and Cloud Storage
4458

4559
.. _gcloud-python-expenses-demo: https://github.com/GoogleCloudPlatform/gcloud-python-expenses-demo
4660

61+
Authentication
62+
--------------
63+
64+
With ``gcloud-python`` we try to make authentication as painless as possible.
65+
Check out the `Authentication section`_ in our documentation to learn more.
66+
You may also find the `authorization document`_ shared by all the ``gcloud-*``
67+
libraries to be helpful.
68+
69+
.. _Authentication section: http://gcloud-python.readthedocs.org/en/latest/gcloud-auth.html
70+
.. _authorization document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authorization
71+
4772
Google Cloud Datastore
4873
----------------------
4974

@@ -163,38 +188,29 @@ to BigQuery using this Client Library.
163188

164189
.. _BigQuery documentation: https://googlecloudplatform.github.io/gcloud-python/stable/bigquery-usage.html
165190

166-
Contributing
167-
------------
191+
Google Cloud Resource Manager
192+
-----------------------------
168193

169-
Contributions to this library are always welcome and highly encouraged.
194+
The Cloud `Resource Manager`_ API (`Resource Manager API docs`_) provides
195+
methods that you can use to programmatically manage your projects in the
196+
Google Cloud Platform.
170197

171-
See `CONTRIBUTING`_ for more information on how to get started.
172-
173-
.. _CONTRIBUTING: https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/CONTRIBUTING.rst
198+
.. _Resource Manager: https://cloud.google.com/resource-manager/
199+
.. _Resource Manager API docs: https://cloud.google.com/resource-manager/reference/rest/
174200

175-
Python Versions
176-
-------------------------
201+
See the ``gcloud-python`` API `Resource Manager documentation`_ to learn how to
202+
manage projects using this Client Library.
177203

178-
We support `Python 2.6`_ and `Python 2.7`_ and plan to support `Python 3.3`_ and
179-
`Python 3.4`_. For more information, see `Supported Python Versions`_ in
180-
``CONTRIBUTING``.
181-
182-
.. _Python 2.6: https://docs.python.org/2.6/
183-
.. _Python 2.7: https://docs.python.org/2.7/
184-
.. _Python 3.3: https://docs.python.org/3.3/
185-
.. _Python 3.4: https://docs.python.org/3.4/
186-
.. _Supported Python Versions: https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/CONTRIBUTING.rst#supported-python-versions
204+
.. _Resource Manager documentation: https://googlecloudplatform.github.io/gcloud-python/stable/resource-manager-api.html
187205

188-
Versioning
189-
----------
206+
Contributing
207+
------------
190208

191-
This library follows `Semantic Versioning`_.
209+
Contributions to this library are always welcome and highly encouraged.
192210

193-
.. _Semantic Versioning: http://semver.org/
211+
See `CONTRIBUTING`_ for more information on how to get started.
194212

195-
It is currently in major version zero (``0.y.z``), which means that anything
196-
may change at any time and the public API should not be considered
197-
stable.
213+
.. _CONTRIBUTING: https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/CONTRIBUTING.rst
198214

199215
License
200216
-------

0 commit comments

Comments
 (0)