Skip to content

Commit 5241cb4

Browse files
tseavertseaver
authored
Bigtable: prep docs for repo split. (#6014)
- Move 'docs/bigtable' -> 'bigtable/docs', leaving a symlink. - Harmonize / DRY 'bigtable/README.rst' and 'bigtable/docs/index.rst'. - Remove generated GAPIC docs (not part of the surface).
1 parent 47e79c9 commit 5241cb4

22 files changed

Lines changed: 119 additions & 183 deletions

‎bigtable/README.rst‎

Lines changed: 70 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,90 @@
1-
Python Client for Google Cloud Bigtable
2-
=======================================
1+
Python Client for Google Cloud Bigtable (`Alpha`_)
2+
==================================================
33

4-
Python idiomatic client for `Google Cloud Bigtable`_
4+
|pypi| |versions|
55

6-
.. _Google Cloud Bigtable: https://cloud.google.com/bigtable/docs/
76

8-
|pypi| |versions|
7+
`Google Cloud Bigtable`_ is Google's NoSQL Big Data database service. It's the
8+
same database that powers many core Google services, including Search,
9+
Analytics, Maps, and Gmail.
910

10-
- `Documentation`_
11+
- `Client Library Documentation`_
12+
- `Product Documentation`_
1113

12-
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/bigtable/usage.html
14+
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
15+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigtable.svg
16+
:target: https://pypi.org/project/google-cloud-bigtable/
17+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigtable.svg
18+
:target: https://pypi.org/project/google-cloud-bigtable/
19+
.. _Google Cloud Bigtable: https://cloud.google.com/bigtable
20+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/bigtable/usage.html
21+
.. _Product Documentation: https://cloud.google.com/bigtable/docs
1322

1423
Quick Start
1524
-----------
1625

17-
.. code-block:: console
26+
In order to use this library, you first need to go through the following steps:
1827

19-
$ pip install --upgrade google-cloud-bigtable
28+
1. `Select or create a Cloud Platform project.`_
29+
2. `Enable billing for your project.`_
30+
3. `Enable the Cloud Bigtable API.`_
31+
4. `Setup Authentication.`_
2032

21-
For more information on setting up your Python development environment,
22-
such as installing ``pip`` and ``virtualenv`` on your system, please refer
23-
to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
33+
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
34+
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
35+
.. _Enable the Cloud Bigtable API.: https://cloud.google.com/bigtable
36+
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
2437

25-
.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup
38+
Installation
39+
~~~~~~~~~~~~
2640

27-
Authentication
28-
--------------
41+
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
42+
create isolated Python environments. The basic problem it addresses is one of
43+
dependencies and versions, and indirectly permissions.
2944

30-
With ``google-cloud-python`` we try to make authentication as painless as
31-
possible. Check out the `Authentication section`_ in our documentation to
32-
learn more. You may also find the `authentication document`_ shared by all
33-
the ``google-cloud-*`` libraries to be helpful.
45+
With `virtualenv`_, it's possible to install this library without needing system
46+
install permissions, and without clashing with the installed system
47+
dependencies.
3448

35-
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
36-
.. _authentication document: https://github.com/GoogleCloudPlatform/google-cloud-common/tree/master/authentication
49+
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
3750

38-
Using the API
39-
-------------
4051

41-
Cloud `Bigtable`_ is Google's NoSQL Big Data database service. It's the same
42-
database that powers many core Google services, including Search,
43-
Analytics, Maps, and Gmail.
52+
Mac/Linux
53+
^^^^^^^^^
4454

45-
.. _Bigtable: https://cloud.google.com/bigtable/docs/
55+
.. code-block:: console
4656
47-
See the ``google-cloud-python`` API Bigtable `Documentation`_ to learn
48-
how to manage your data in Bigtable tables.
57+
pip install virtualenv
58+
virtualenv <your-env>
59+
source <your-env>/bin/activate
60+
<your-env>/bin/pip install google-cloud-bigtable
4961
50-
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-bigtable.svg
51-
:target: https://pypi.org/project/google-cloud-bigtable/
52-
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-bigtable.svg
53-
:target: https://pypi.org/project/google-cloud-bigtable/
62+
63+
Windows
64+
^^^^^^^
65+
66+
.. code-block:: console
67+
68+
pip install virtualenv
69+
virtualenv <your-env>
70+
<your-env>\Scripts\activate
71+
<your-env>\Scripts\pip.exe install google-cloud-bigtable
72+
73+
Next Steps
74+
~~~~~~~~~~
75+
76+
- Read the `Client Library Documentation`_ for Cloud Bigtable API
77+
to see other available methods on the client.
78+
- Read the `Product documentation`_ to learn
79+
more about the product and see How-to Guides.
80+
81+
``google-cloud-happybase``
82+
--------------------------
83+
84+
In addition to the core ``google-cloud-bigtable``, we provide a
85+
`google-cloud-happybase
86+
<http://google-cloud-python-happybase.readthedocs.io/en/latest/>`__ library
87+
with the same interface as the popular `HappyBase
88+
<https://happybase.readthedocs.io/en/latest/>`__ library. Unlike HappyBase,
89+
``google-cloud-happybase`` uses ``google-cloud-bigtable`` under the covers,
90+
rather than Apache HBase.

‎bigtable/docs/changelog.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CHANGELOG.md

docs/bigtable/client-intro.rst renamed to bigtable/docs/client-intro.rst

File renamed without changes.

docs/bigtable/client.rst renamed to bigtable/docs/client.rst

File renamed without changes.

docs/bigtable/cluster.rst renamed to bigtable/docs/cluster.rst

File renamed without changes.

docs/bigtable/column-family.rst renamed to bigtable/docs/column-family.rst

File renamed without changes.

docs/bigtable/data-api.rst renamed to bigtable/docs/data-api.rst

File renamed without changes.

‎bigtable/docs/gapic/v2/api.rst‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎bigtable/docs/gapic/v2/types.rst‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎bigtable/docs/index.rst‎

Lines changed: 18 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,30 @@
1-
Python Client for Cloud Bigtable API (`Alpha`_)
2-
===============================================
1+
.. include:: /../bigtable/README.rst
32

4-
`Cloud Bigtable API`_: API for reading and writing the contents of Bigtables associated with a
5-
cloud project.
63

7-
- `Client Library Documentation`_
8-
- `Product Documentation`_
9-
10-
.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
11-
.. _Cloud Bigtable API: https://cloud.google.com/bigtable
12-
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/bigtable/usage.html
13-
.. _Product Documentation: https://cloud.google.com/bigtable
14-
15-
Quick Start
16-
-----------
17-
18-
In order to use this library, you first need to go through the following steps:
19-
20-
1. `Select or create a Cloud Platform project.`_
21-
2. `Enable billing for your project.`_
22-
3. `Enable the Cloud Bigtable API.`_
23-
4. `Setup Authentication.`_
24-
25-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
26-
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
27-
.. _Enable the Cloud Bigtable API.: https://cloud.google.com/bigtable
28-
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
29-
30-
Installation
31-
~~~~~~~~~~~~
32-
33-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
34-
create isolated Python environments. The basic problem it addresses is one of
35-
dependencies and versions, and indirectly permissions.
36-
37-
With `virtualenv`_, it's possible to install this library without needing system
38-
install permissions, and without clashing with the installed system
39-
dependencies.
40-
41-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
42-
43-
44-
Mac/Linux
45-
^^^^^^^^^
46-
47-
.. code-block:: console
48-
49-
pip install virtualenv
50-
virtualenv <your-env>
51-
source <your-env>/bin/activate
52-
<your-env>/bin/pip install google-cloud-bigtable
4+
Using the API
5+
-------------
6+
.. toctree::
7+
:maxdepth: 2
538

9+
usage
5410

55-
Windows
56-
^^^^^^^
5711

58-
.. code-block:: console
12+
API Reference
13+
-------------
14+
.. toctree::
15+
:maxdepth: 2
5916

60-
pip install virtualenv
61-
virtualenv <your-env>
62-
<your-env>\Scripts\activate
63-
<your-env>\Scripts\pip.exe install google-cloud-bigtable
17+
instance-api
18+
table-api
19+
data-api
6420

65-
Next Steps
66-
~~~~~~~~~~
6721

68-
- Read the `Client Library Documentation`_ for Cloud Bigtable API
69-
API to see other available methods on the client.
70-
- Read the `Cloud Bigtable API Product documentation`_ to learn
71-
more about the product and see How-to Guides.
72-
- View this `repository’s main README`_ to see the full list of Cloud
73-
APIs that we cover.
22+
Changelog
23+
---------
7424

75-
.. _Cloud Bigtable API Product documentation: https://cloud.google.com/bigtable
76-
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
25+
For a list of all ``google-cloud-datastore`` releases:
7726

78-
Api Reference
79-
-------------
8027
.. toctree::
81-
:maxdepth: 2
28+
:maxdepth: 2
8229

83-
gapic/v2/api
84-
gapic/v2/types
30+
changelog

0 commit comments

Comments
 (0)