Skip to content

Commit 34d652e

Browse files
committed
Merge pull request #1078 from dhermes/fix-1076
Adding BigQuery and Pub/Sub to README.
2 parents ddb26e2 + f3d9bb0 commit 34d652e

1 file changed

Lines changed: 57 additions & 4 deletions

File tree

README.rst

Lines changed: 57 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,13 @@ This client supports the following Google Cloud Platform services:
1717

1818
- `Google Cloud Datastore`_
1919
- `Google Cloud Storage`_
20+
- `Google Cloud Pub/Sub`_
21+
- `Google BigQuery`_
2022

21-
.. _Google Cloud Datastore: #google-cloud-datastore
22-
.. _Google Cloud Storage: #google-cloud-storage
23+
.. _Google Cloud Datastore: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-datastore
24+
.. _Google Cloud Storage: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-storage
25+
.. _Google Cloud Pub/Sub: https://github.com/GoogleCloudPlatform/gcloud-python#google-cloud-pubsub
26+
.. _Google BigQuery: https://github.com/GoogleCloudPlatform/gcloud-python#google-bigquery
2327

2428
If you need support for other Google APIs, check out the
2529
`Google APIs Python Client library`_.
@@ -31,7 +35,7 @@ Quickstart
3135

3236
::
3337

34-
$ pip install gcloud
38+
$ pip install --upgrade gcloud
3539

3640
Example Applications
3741
--------------------
@@ -90,7 +94,7 @@ be used to distribute large data objects to users via direct download.
9094
See the ``gcloud-python`` API `storage documentation`_ to learn how to connect
9195
to Cloud Storage using this Client Library.
9296

93-
.. _storage documentation: https://googlecloudplatform.github.io/gcloud-python/stable/storage-api.html
97+
.. _storage documentation: https://googlecloudplatform.github.io/gcloud-python/stable/storage-client.html
9498

9599
You need to create a Google Cloud Storage bucket to use this client library.
96100
Follow along with the `official Google Cloud Storage documentation`_ to learn
@@ -110,6 +114,55 @@ how to create a bucket.
110114
blob2 = bucket.blob('/remote/path/storage.txt')
111115
blob2.upload_from_filename(filename='/local/path.txt')
112116
117+
Google Cloud Pub/Sub
118+
--------------------
119+
120+
Google `Cloud Pub/Sub`_ (`Pub/Sub API docs`_) is designed to provide reliable,
121+
many-to-many, asynchronous messaging between applications. Publisher
122+
applications can send messages to a ``topic`` and other applications can
123+
subscribe to that topic to receive the messages. By decoupling senders and
124+
receivers, Google Cloud Pub/Sub allows developers to communicate between
125+
independently written applications.
126+
127+
.. _Cloud Pub/Sub: https://cloud.google.com/pubsub/docs
128+
.. _Pub/Sub API docs: https://cloud.google.com/pubsub/reference/rest/
129+
130+
See the ``gcloud-python`` API `Pub/Sub documentation`_ to learn how to connect
131+
to Cloud Pub/Sub using this Client Library.
132+
133+
.. _Pub/Sub documentation: https://googlecloudplatform.github.io/gcloud-python/stable/pubsub-usage.html
134+
135+
To get started with this API, you'll need to create
136+
137+
.. code:: python
138+
139+
from gcloud import pubsub
140+
141+
client = pubsub.Client()
142+
topic = client.topic('topic_name')
143+
topic.create()
144+
145+
topic.publish('this is the message_payload',
146+
attr1='value1', attr2='value2')
147+
148+
Google BigQuery
149+
---------------
150+
151+
Querying massive datasets can be time consuming and expensive without the
152+
right hardware and infrastructure. Google `BigQuery`_ (`BigQuery API docs`_)
153+
solves this problem by enabling super-fast, SQL-like queries against
154+
append-only tables, using the processing power of Google's infrastructure.
155+
156+
.. _BigQuery: https://cloud.google.com/bigquery/what-is-bigquery
157+
.. _BigQuery API docs: https://cloud.google.com/bigquery/docs/reference/v2/
158+
159+
This package is still being implemented, but it is almost complete!
160+
161+
See the ``gcloud-python`` API `BigQuery documentation`_ to learn how to connect
162+
to BigQuery using this Client Library.
163+
164+
.. _BigQuery documentation: https://googlecloudplatform.github.io/gcloud-python/stable/bigquery-usage.html
165+
113166
Contributing
114167
------------
115168

0 commit comments

Comments
 (0)