bigtable: Move hello to hello_happybase. [(googleapis#383)](GoogleClo…

…udPlatform/python-docs-samples#383)

samples/hello_happybase/README.md

@@ -0,0 +1,67 @@
+# Cloud Bigtable Hello World
+
+This is a simple application that demonstrates using the [Google Cloud Client
+Library][gcloud-python] to connect to and interact with Cloud Bigtable.
+
+[gcloud-python]: https://github.com/GoogleCloudPlatform/gcloud-python
+
+
+## Provision a cluster
+
+Follow the instructions in the [user documentation](https://cloud.google.com/bigtable/docs/creating-cluster)
+to create a Google Cloud Platform project and Cloud Bigtable cluster if necessary.
+You'll need to reference your project ID, zone and cluster ID to run the application.
+
+
+## Run the application
+
+First, set your [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials)
+
+Install the dependencies with pip.
+
+```
+$ pip install -r requirements.txt
+```
+
+Run the application. Replace the command-line parameters with values for your cluster.
+
+```
+$ python main.py my-project my-cluster us-central1-c
+```
+
+You will see output resembling the following:
+
+```
+Create table Hello-Bigtable-1234
+Write some greetings to the table
+Scan for all greetings:
+        greeting0: Hello World!
+        greeting1: Hello Cloud Bigtable!
+        greeting2: Hello HappyBase!
+Delete table Hello-Bigtable-1234
+```
+
+## Understanding the code
+
+The [application](main.py) uses the [Google Cloud Bigtable HappyBase
+package][Bigtable HappyBase], an implementation of the [HappyBase][HappyBase]
+library, to make calls to Cloud Bigtable. It demonstrates several basic
+concepts of working with Cloud Bigtable via this API:
+
+[Bigtable HappyBase]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-package.html
+[HappyBase]: http://happybase.readthedocs.io/en/latest/index.html
+
+- Creating a [Connection][HappyBase Connection] to a Cloud Bigtable
+  [Cluster][Cluster API].
+- Using the [Connection][HappyBase Connection] interface to create, disable and
+  delete a [Table][HappyBase Table].
+- Using the Connection to get a Table.
+- Using the Table to write rows via a [put][HappyBase Table Put] and scan
+  across multiple rows using [scan][HappyBase Table Scan].
+
+[Cluster API]: https://googlecloudplatform.github.io/gcloud-python/stable/bigtable-cluster.html
+[HappyBase Connection]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-connection.html
+[HappyBase Table]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-table.html
+[HappyBase Table Put]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-table.html#gcloud.bigtable.happybase.table.Table.put
+[HappyBase Table Scan]: https://googlecloudplatform.github.io/gcloud-python/stable/happybase-table.html#gcloud.bigtable.happybase.table.Table.scan
+

samples/hello_happybase/main.py

@@ -0,0 +1,119 @@
+#!/usr/bin/env python
+
+# Copyright 2016 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Demonstrates how to connect to Cloud Bigtable and run some basic operations.
+
+Prerequisites:
+
+- Create a Cloud Bigtable cluster.
+  https://cloud.google.com/bigtable/docs/creating-cluster
+- Set your Google Application Default Credentials.
+  https://developers.google.com/identity/protocols/application-default-credentials
+- Set the GCLOUD_PROJECT environment variable to your project ID.
+  https://support.google.com/cloud/answer/6158840
+"""
+
+import argparse
+
+from gcloud import bigtable
+from gcloud.bigtable import happybase
+
+
+def main(project_id, cluster_id, zone, table_name):
+    # [START connecting_to_bigtable]
+    # The client must be created with admin=True because it will create a
+    # table.
+    client = bigtable.Client(project=project_id, admin=True)
+    cluster = client.cluster(zone, cluster_id)
+    connection = happybase.Connection(cluster=cluster)
+    # [END connecting_to_bigtable]
+
+    try:
+        # [START creating_a_table]
+        print('Creating the {} table.'.format(table_name))
+        column_family_name = 'cf1'
+        connection.create_table(
+            table_name,
+            {
+                column_family_name: dict()  # Use default options.
+            })
+        # [END creating_a_table]
+
+        # [START writing_rows]
+        print('Writing some greetings to the table.')
+        table = connection.table(table_name)
+        column_name = '{fam}:greeting'.format(fam=column_family_name)
+        greetings = [
+            'Hello World!',
+            'Hello Cloud Bigtable!',
+            'Hello HappyBase!',
+        ]
+        for i, value in enumerate(greetings):
+            # Note: This example uses sequential numeric IDs for simplicity,
+            # but this can result in poor performance in a production
+            # application.  Since rows are stored in sorted order by key,
+            # sequential keys can result in poor distribution of operations
+            # across nodes.
+            #
+            # For more information about how to design a Bigtable schema for
+            # the best performance, see the documentation:
+            #
+            #     https://cloud.google.com/bigtable/docs/schema-design
+            row_key = 'greeting{}'.format(i)
+            table.put(row_key, {column_name: value})
+        # [END writing_rows]
+
+        # [START getting_a_row]
+        print('Getting a single greeting by row key.')
+        key = 'greeting0'
+        row = table.row(key)
+        print('\t{}: {}'.format(key, row[column_name]))
+        # [END getting_a_row]
+
+        # [START scanning_all_rows]
+        print('Scanning for all greetings:')
+        for key, row in table.scan():
+            print('\t{}: {}'.format(key, row[column_name]))
+        # [END scanning_all_rows]
+
+        # [START deleting_a_table]
+        print('Deleting the {} table.'.format(table_name))
+        connection.delete_table(table_name)
+        # [END deleting_a_table]
+    finally:
+        connection.close()
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(
+        description='A sample application that connects to Cloud' +
+                    ' Bigtable.',
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+    parser.add_argument(
+        'project_id',
+        help='Google Cloud Platform project ID that contains the Cloud' +
+             ' Bigtable cluster.')
+    parser.add_argument(
+        'cluster', help='ID of the Cloud Bigtable cluster to connect to.')
+    parser.add_argument(
+        'zone', help='Zone that contains the Cloud Bigtable cluster.')
+    parser.add_argument(
+        '--table',
+        help='Table to create and destroy.',
+        default='Hello-Bigtable')
+
+    args = parser.parse_args()
+    main(args.project_id, args.cluster, args.zone, args.table)

samples/hello_happybase/main_test.py

@@ -0,0 +1,49 @@
+# Copyright 2016 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import random
+import re
+import sys
+
+from main import main
+
+import pytest
+
+TABLE_NAME_FORMAT = 'Hello-Bigtable-{}'
+TABLE_NAME_RANGE = 10000
+
+
+@pytest.mark.skipif(
+    sys.version_info >= (3, 0),
+    reason=("grpc doesn't yet support python3 "
+            'https://github.com/grpc/grpc/issues/282'))
+def test_main(cloud_config, capsys):
+    table_name = TABLE_NAME_FORMAT.format(
+        random.randrange(TABLE_NAME_RANGE))
+    main(
+        cloud_config.project,
+        cloud_config.bigtable_cluster,
+        cloud_config.bigtable_zone,
+        table_name)
+
+    out, _ = capsys.readouterr()
+    assert re.search(
+        re.compile(r'Creating the Hello-Bigtable-[0-9]+ table\.'), out)
+    assert re.search(re.compile(r'Writing some greetings to the table\.'), out)
+    assert re.search(re.compile(r'Getting a single greeting by row key.'), out)
+    assert re.search(re.compile(r'greeting0: Hello World!'), out)
+    assert re.search(re.compile(r'Scanning for all greetings'), out)
+    assert re.search(re.compile(r'greeting1: Hello Cloud Bigtable!'), out)
+    assert re.search(
+        re.compile(r'Deleting the Hello-Bigtable-[0-9]+ table\.'), out)

samples/hello_happybase/requirements.txt

@@ -0,0 +1 @@
+gcloud[grpc]==0.14.0