Skip to content

Commit cf643c8

Browse files
Adding README for Bigtable python samples (#1661)
* Adding README for Bigtable python samples * Regenerating readme * Regenerating readme
1 parent 93b703d commit cf643c8

File tree

2 files changed

+109
-0
lines changed

2 files changed

+109
-0
lines changed

bigtable/README.rst

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
.. This file is automatically generated. Do not edit this file directly.
2+
3+
Google Cloud Bigtable Python Samples
4+
===============================================================================
5+
6+
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
7+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/README.rst
8+
9+
10+
This directory contains samples for Google Cloud Bigtable. `Google Cloud Bigtable`_ is Google's NoSQL Big Data database service. It's the same database that powers many core Google services, including Search, Analytics, Maps, and Gmail.
11+
12+
13+
This directory contains samples that demonstrate using the Google Cloud Client Library for
14+
Python as well as the `Google Cloud Client Library HappyBase package`_ to connect to and
15+
interact with Cloud Bigtable.
16+
17+
.. _Google Cloud Client Library HappyBase package:
18+
https://github.com/GoogleCloudPlatform/google-cloud-python-happybase
19+
20+
21+
.. _Google Cloud Bigtable: https://cloud.google.com/bigtable/docs
22+
23+
Setup
24+
-------------------------------------------------------------------------------
25+
26+
27+
Authentication
28+
++++++++++++++
29+
30+
This sample requires you to have authentication setup. Refer to the
31+
`Authentication Getting Started Guide`_ for instructions on setting up
32+
credentials for applications.
33+
34+
.. _Authentication Getting Started Guide:
35+
https://cloud.google.com/docs/authentication/getting-started
36+
37+
Install Dependencies
38+
++++++++++++++++++++
39+
40+
#. Clone python-docs-samples and change directory to the sample directory you want to use.
41+
42+
.. code-block:: bash
43+
44+
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
45+
46+
#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.
47+
48+
.. _Python Development Environment Setup Guide:
49+
https://cloud.google.com/python/setup
50+
51+
#. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.
52+
53+
.. code-block:: bash
54+
55+
$ virtualenv env
56+
$ source env/bin/activate
57+
58+
#. Install the dependencies needed to run the samples.
59+
60+
.. code-block:: bash
61+
62+
$ pip install -r requirements.txt
63+
64+
.. _pip: https://pip.pypa.io/
65+
.. _virtualenv: https://virtualenv.pypa.io/
66+
67+
68+
69+
The client library
70+
-------------------------------------------------------------------------------
71+
72+
This sample uses the `Google Cloud Client Library for Python`_.
73+
You can read the documentation for more details on API usage and use GitHub
74+
to `browse the source`_ and `report issues`_.
75+
76+
.. _Google Cloud Client Library for Python:
77+
https://googlecloudplatform.github.io/google-cloud-python/
78+
.. _browse the source:
79+
https://github.com/GoogleCloudPlatform/google-cloud-python
80+
.. _report issues:
81+
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
82+
83+
84+
.. _Google Cloud SDK: https://cloud.google.com/sdk/

bigtable/README.rst.in

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# This file is used to generate README.rst
2+
3+
product:
4+
name: Google Cloud Bigtable
5+
short_name: Cloud Bigtable
6+
url: https://cloud.google.com/bigtable/docs
7+
description: >
8+
`Google Cloud Bigtable`_ is Google's NoSQL Big Data database service. It's
9+
the same database that powers many core Google services, including Search,
10+
Analytics, Maps, and Gmail.
11+
12+
description: |
13+
This directory contains samples that demonstrate using the Google Cloud Client Library for
14+
Python as well as the `Google Cloud Client Library HappyBase package`_ to connect to and
15+
interact with Cloud Bigtable.
16+
17+
.. _Google Cloud Client Library HappyBase package:
18+
https://github.com/GoogleCloudPlatform/google-cloud-python-happybase
19+
20+
setup:
21+
- auth
22+
- install_deps
23+
24+
25+
cloud_client_library: true

0 commit comments

Comments
 (0)