Update docs on running demo to explain environment variables.

googleapis · Nov 24, 2014 · 73885a3 · 73885a3
1 parent 48c50d1
commit 73885a3
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/docs/datastore-quickstart.rst b/docs/datastore-quickstart.rst
@@ -21,6 +21,24 @@ You can install the library quickly with ``pip``::
 
   $ pip install gcloud
 
+Run the demo
+------------
+
+In order to run the demo, you need to have registred an actual ``gcloud``
+project and so you'll need to provide some environment variables to facilitate
+authentication to your project:
+
+  - ``GCLOUD_TESTS_PROJECT_ID``: Developers Console project ID (e.g.
+    bamboo-shift-455).
+  - ``GCLOUD_TESTS_DATASET_ID``: The name of the dataset your tests connect to.
+    This is typically the same as ``GCLOUD_TESTS_PROJECT_ID``.
+  - ``GCLOUD_TESTS_CLIENT_EMAIL``: The email for the service account you're
+    authenticating with
+  - ``GCLOUD_TESTS_KEY_FILE``: The path to an encrypted key file.
+    See private key
+    `docs <https://cloud.google.com/storage/docs/authentication#generating-a-private-key>`__
+    for explanation on how to get a private key.
+
 Run the
 `example script <https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/gcloud/datastore/demo/demo.py>`_
 included in the package::

diff --git a/docs/storage-quickstart.rst b/docs/storage-quickstart.rst
@@ -11,6 +11,24 @@ You can install the library quickly with ``pip``::
 
   $ pip install gcloud
 
+Run the demo
+------------
+
+In order to run the demo, you need to have registred an actual ``gcloud``
+project and so you'll need to provide some environment variables to facilitate
+authentication to your project:
+
+  - ``GCLOUD_TESTS_PROJECT_ID``: Developers Console project ID (e.g.
+    bamboo-shift-455).
+  - ``GCLOUD_TESTS_DATASET_ID``: The name of the dataset your tests connect to.
+    This is typically the same as ``GCLOUD_TESTS_PROJECT_ID``.
+  - ``GCLOUD_TESTS_CLIENT_EMAIL``: The email for the service account you're
+    authenticating with
+  - ``GCLOUD_TESTS_KEY_FILE``: The path to an encrypted key file.
+    See private key
+    `docs <https://cloud.google.com/storage/docs/authentication#generating-a-private-key>`__
+    for explanation on how to get a private key.
+
 Run the
 `example script <https://github.com/GoogleCloudPlatform/gcloud-python/blob/master/gcloud/storage/demo/demo.py>`_
 included in the package::