Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions docs/bigtable-client-intro.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Base for Everything
===================

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

To use the API, the :class:`Client <gcloud.bigtable.client.Client>`
class defines a high-level interface which handles authorization
and creating other objects:
Expand Down
6 changes: 6 additions & 0 deletions docs/bigtable-client.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Client
~~~~~~

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.client
:members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/bigtable-cluster-api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Cluster Admin API
=================

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

After creating a :class:`Client <gcloud.bigtable.client.Client>`, you can
interact with individual clusters, groups of clusters or available
zones for a project.
Expand Down
6 changes: 6 additions & 0 deletions docs/bigtable-cluster.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Cluster
~~~~~~~

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.cluster
:members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/bigtable-column-family.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Column Families
===============

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

When creating a
:class:`ColumnFamily <gcloud.bigtable.column_family.ColumnFamily>`, it is
possible to set garbage collection rules for expired data.
Expand Down
6 changes: 6 additions & 0 deletions docs/bigtable-data-api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Data API
========

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

After creating a :class:`Table <gcloud.bigtable.table.Table>` and some
column families, you are ready to store and retrieve data.

Expand Down
6 changes: 6 additions & 0 deletions docs/bigtable-row-data.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Row Data
~~~~~~~~

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.row_data
:members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/bigtable-row-filters.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Bigtable Row Filters
====================

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

It is possible to use a
:class:`RowFilter <gcloud.bigtable.row_filters.RowFilter>`
when adding mutations to a
Expand Down
6 changes: 6 additions & 0 deletions docs/bigtable-row.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Bigtable Row
============

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.row
:members:
:show-inheritance:
Expand Down
6 changes: 6 additions & 0 deletions docs/bigtable-table-api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Table Admin API
===============

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

After creating a :class:`Cluster <gcloud.bigtable.cluster.Cluster>`, you can
interact with individual tables, groups of tables or column families within
a table.
Expand Down
6 changes: 6 additions & 0 deletions docs/bigtable-table.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Table
~~~~~

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.table
:members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/bigtable-usage.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Using the API
=============

.. warning::

`gRPC`_ is required for using the Cloud Bigtable API. As of May 2016,
`grpcio`_ is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

API requests are sent to the `Google Cloud Bigtable`_ API via RPC over HTTP/2.
In order to support this, we'll rely on `gRPC`_. We are working with the gRPC
team to rapidly make the install story more user-friendly.
Expand All @@ -23,3 +29,4 @@ In the hierarchy of API concepts

.. _Google Cloud Bigtable: https://cloud.google.com/bigtable/docs/
.. _gRPC: http://www.grpc.io/
.. _grpcio: https://pypi.python.org/pypi/grpcio
6 changes: 6 additions & 0 deletions docs/happybase-batch.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
HappyBase Batch
~~~~~~~~~~~~~~~

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.happybase.batch
:members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/happybase-connection.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
HappyBase Connection
~~~~~~~~~~~~~~~~~~~~

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.happybase.connection
:members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/happybase-package.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
HappyBase Package
~~~~~~~~~~~~~~~~~

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.happybase.__init__
:members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/happybase-pool.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
HappyBase Connection Pool
~~~~~~~~~~~~~~~~~~~~~~~~~

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.happybase.pool
:members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/happybase-table.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
HappyBase Table
~~~~~~~~~~~~~~~

.. warning::

gRPC is required for using the Cloud Bigtable API. As of May 2016,
``grpcio`` is only supported in Python 2.7, so importing
:mod:`gcloud.bigtable` in other versions of Python will fail.

.. automodule:: gcloud.bigtable.happybase.table
:members:
:show-inheritance:
20 changes: 20 additions & 0 deletions gcloud/bigtable/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,23 @@


from gcloud.bigtable.client import Client


_ERR_MSG = """\
gRPC is required for using the Cloud Bigtable API, but
importing the gRPC library (grpcio in PyPI) has failed.

As of June 2016, grpcio is only supported in Python 2.7,
which unfortunately means the Cloud Bigtable API isn't
available if you're using Python 3 or Python < 2.7.

If you're using Python 2.7 and importing / installing
grpcio has failed, this likely means you have a non-standard version
of Python installed. Check http://grpc.io if you're
having trouble installing the grpcio package.
"""

try:
import grpc.beta.implementations
except ImportError as exc: # pragma: NO COVER
raise ImportError(_ERR_MSG, exc)
8 changes: 5 additions & 3 deletions scripts/verify_included_modules.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,11 @@ def main():
public_mods = set(public_mods)

if not sphinx_mods <= public_mods:
message = ('Unexpected error. There were modules referenced by '
'Sphinx that are not among the public modules.')
print(message, file=sys.stderr)
unexpected_mods = sphinx_mods - public_mods
message = ['Unexpected error. There were modules referenced by '
'Sphinx that are not among the public modules.']
message.extend(['- %s' % (mod,) for mod in unexpected_mods])
print('\n'.join(message), file=sys.stderr)
sys.exit(1)

undocumented_mods = public_mods - sphinx_mods
Expand Down
4 changes: 4 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import os
import sys

from setuptools import setup
from setuptools import find_packages
Expand All @@ -23,6 +24,9 @@
'gax-google-pubsub-v1',
]

if sys.version_info[:2] == (2, 7):
REQUIREMENTS.extend(GRPC_EXTRAS)

setup(
name='gcloud',
version='0.14.0',
Expand Down