Skip to content

Fixing README.rst to render correctly on PyPI. #434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dhermes merged 2 commits into from
Dec 18, 2014
Merged

Fixing README.rst to render correctly on PyPI. #434

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48249e1
Fixing README.rst to render correctly on PyPI.
dhermes Dec 18, 2014
beb58b1
Fixing final relative link and de-denting main description.
dhermes Dec 18, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 81 additions & 57 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,38 @@
Google Cloud Python Client
==========================

Python idiomatic client for Google Cloud Platform services.
Python idiomatic client for Google Cloud Platform services.

|build| |coverage|
------------------

- `Homepage <https://googlecloudplatform.github.io/gcloud-python/>`__
- `Homepage`_

.. _Homepage: https://googlecloudplatform.github.io/gcloud-python/

This client supports the following Google Cloud Platform services:

- `Google Cloud
Datastore <https://cloud.google.com/products/cloud-datastore/>`__
- `Google Cloud
Storage <https://cloud.google.com/products/cloud-storage/>`__
- `Google Cloud Datastore`_
- `Google Cloud Storage`_

.. _Google Cloud Datastore: https://cloud.google.com/products/cloud-datastore/
.. _Google Cloud Storage: https://cloud.google.com/products/cloud-storage/

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

If you need support for other Google APIs, check out the `Google APIs
Python Client
library <https://github.com/google/google-api-python-client>`__.
.. _Google APIs Python Client library: https://github.com/google/google-api-python-client

Versioning
----------
This library follows `Semantic Versioning <http://semver.org/>`__.

It is currently in major version zero (0.y.z), which means that
anything may change at any time and the public API should not be
considered stable.
This library follows `Semantic Versioning`_.

.. _Semantic Versioning: http://semver.org/

It is currently in major version zero (``0.y.z``), which means that anything
may change at any time and the public API should not be considered
stable.

Quickstart
----------
Expand All @@ -37,21 +44,23 @@ Quickstart
Google Cloud Datastore
----------------------

`Google Cloud Datastore <https://developers.google.com/datastore/>`__ is
a fully managed, schemaless database for storing non-relational data.
Cloud Datastore automatically scales with your users and supports ACID
transactions, high availability of reads and writes, strong consistency
for reads and ancestor queries, and eventual consistency for all other
queries.
Google `Cloud Datastore`_ is a fully managed, schemaless database for
storing non-relational data. Cloud Datastore automatically scales with
your users and supports ACID transactions, high availability of reads and
writes, strong consistency for reads and ancestor queries, and eventual
consistency for all other queries.

See the `Google Cloud Datastore
docs <https://developers.google.com/datastore/docs/activate>`__ for more
details on how to activate Cloud Datastore for your project.
.. _Cloud Datastore: https://developers.google.com/datastore/

See `the gcloud-python API
documentation <https://googlecloudplatform.github.io/gcloud-python/datastore-api.html>`__
to learn how to interact with the Cloud Datastore using this Client
Library.
See the `Google Cloud Datastore docs`_ for more details on how to activate
Cloud Datastore for your project.

.. _Google Cloud Datastore docs: https://developers.google.com/datastore/docs/activate

See the ``gcloud-python`` API `datastore documentation`_ to learn how to interact
with the Cloud Datastore using this Client Library.

.. _datastore documentation: https://googlecloudplatform.github.io/gcloud-python/datastore-api.html

.. code:: python

Expand All @@ -64,19 +73,22 @@ Library.
Google Cloud Storage
--------------------

`Google Cloud Storage <https://developers.google.com/storage/>`__ allows
you to store data on Google infrastructure with very high reliability,
performance and availability, and can be used to distribute large data
objects to users via direct download.
Google `Cloud Storage`_ allows you to store data on Google infrastructure with
very high reliability, performance and availability, and can be used to
distribute large data objects to users via direct download.

.. _Cloud Storage: https://developers.google.com/storage/

You need to create a Google Cloud Storage bucket to use this client
library. Follow the steps on the `Google Cloud Storage
docs <https://developers.google.com/storage/docs/cloud-console#_creatingbuckets>`__
library. Follow the steps on the `Google Cloud Storage docs`_
to learn how to create a bucket.

See `the gcloud-python API
documentation <https://googlecloudplatform.github.io/gcloud-python/storage-api.html>`__
to learn how to connect to the Cloud Storage using this Client Library.
.. _Google Cloud Storage docs: https://developers.google.com/storage/docs/cloud-console#_creatingbuckets

See the ``gcloud-python`` API `storage documentation`_ to learn how to connect
to Cloud Storage using this Client Library.

.. _storage documentation: https://googlecloudplatform.github.io/gcloud-python/storage-api.html

.. code:: python

Expand All @@ -93,46 +105,58 @@ Contributing

Contributions to this library are always welcome and highly encouraged.

See `CONTRIBUTING <CONTRIBUTING.rst>`__ for more information on how to
get started.
See `CONTRIBUTING`_ for more information on how to get started.

.. _CONTRIBUTING: https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/CONTRIBUTING.rst

Supported Python Versions
-------------------------

We support:

- `Python 2.6 <https://docs.python.org/2.6/>`__
- `Python 2.7 <https://docs.python.org/2.7/>`__
- `Python 2.6`_
- `Python 2.7`_

We plan to support:

- `Python 3.3 <https://docs.python.org/3.3/>`__
- `Python 3.4 <https://docs.python.org/3.4/>`__
- `Python 3.3`_
- `Python 3.4`_

.. _Python 2.6: https://docs.python.org/2.6/
.. _Python 2.7: https://docs.python.org/2.7/
.. _Python 3.3: https://docs.python.org/3.3/
.. _Python 3.4: https://docs.python.org/3.4/

Supported versions can be found in our ``tox.ini``
`config <https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/tox.ini>`__.
Supported versions can be found in our ``tox.ini`` `config`_.

We explicitly decided not to support
`Python 2.5 <https://docs.python.org/2.5/>`__ due to
`decreased usage <https://caremad.io/2013/10/a-look-at-pypi-downloads/>`__ and
lack of continuous integration
`support <http://blog.travis-ci.com/2013-11-18-upcoming-build-environment-updates/>`__.
.. _config: https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/tox.ini

We also explicitly decided to support Python 3 beginning with version 3.3.
Reasons for this include:
We explicitly decided not to support `Python 2.5`_ due to `decreased usage`_
and lack of continuous integration `support`_.

.. _Python 2.5: https://docs.python.org/2.5/
.. _decreased usage: https://caremad.io/2013/10/a-look-at-pypi-downloads/
.. _support: http://blog.travis-ci.com/2013-11-18-upcoming-build-environment-updates/

We also explicitly decided to support Python 3 beginning with version
3.3. Reasons for this include:

- Encouraging use of newest versions of Python 3
- Taking the lead of prominent open-source
`projects <http://flask.pocoo.org/docs/0.10/python3/>`__
- Unicode literal `support <https://www.python.org/dev/peps/pep-0414>`__ which
allows for a cleaner codebase that works in both Python 2 and Python 3.
- Taking the lead of prominent open-source `projects`_
- `Unicode literal support`_ which allows for a cleaner codebase that
works in both Python 2 and Python 3

.. _projects: http://flask.pocoo.org/docs/0.10/python3/
.. _Unicode literal support: https://www.python.org/dev/peps/pep-0414/

License
-------

Apache 2.0 - See `LICENSE <LICENSE>`__ for more information.
Apache 2.0 - See `LICENSE`_ for more information.

.. _LICENSE: https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/LICENSE

.. |build| image:: https://travis-ci.org/GoogleCloudPlatform/gcloud-python.svg?branch=master
:target: https://travis-ci.org/GoogleCloudPlatform/gcloud-python
:target: https://travis-ci.org/GoogleCloudPlatform/gcloud-python
.. |coverage| image:: https://coveralls.io/repos/GoogleCloudPlatform/gcloud-python/badge.png?branch=master
:target: https://coveralls.io/r/GoogleCloudPlatform/gcloud-python?branch=master
:target: https://coveralls.io/r/GoogleCloudPlatform/gcloud-python?branch=master