Skip to main content

Google Cloud Pub/Sub API client library

Project description

beta pypi versions

Google Cloud Pub / Sub is a fully-managed real-time messaging service that allows you to send and receive messages between independent applications. You can leverage Cloud Pub/Sub’s flexibility to decouple systems and components hosted on Google Cloud Platform or elsewhere on the Internet. By building on the same technology Google uses, Cloud Pub / Sub is designed to provide “at least once” delivery at low latency with on-demand scalability to 1 million messages per second (and beyond).

Publisher applications can send messages to a topic and other applications can subscribe to that topic to receive the messages. By decoupling senders and receivers, Google Cloud Pub/Sub allows developers to communicate between independently written applications.

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Pub / Sub API.
  4. Setup Authentication.


Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.

With virtualenv, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Supported Python Versions

Python >= 3.5

Deprecated Python Versions

Python == 2.7. Python 2.7 support will be removed on January 1, 2020.


pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-pubsub


pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\pip.exe install google-cloud-pubsub

Example Usage


To publish data to Cloud Pub/Sub you must create a topic, and then publish messages to it

import os
from import pubsub_v1

publisher = pubsub_v1.PublisherClient()
topic_name = 'projects/{project_id}/topics/{topic}'.format(
    topic='MY_TOPIC_NAME',  # Set this to something appropriate.
publisher.publish(topic_name, b'My first message!', spam='eggs')

To learn more, consult the publishing documentation.


To subscribe to data in Cloud Pub/Sub, you create a subscription based on the topic, and subscribe to that, passing a callback function.

import os
from import pubsub_v1

subscriber = pubsub_v1.SubscriberClient()
topic_name = 'projects/{project_id}/topics/{topic}'.format(
    topic='MY_TOPIC_NAME',  # Set this to something appropriate.
subscription_name = 'projects/{project_id}/subscriptions/{sub}'.format(
    sub='MY_SUBSCRIPTION_NAME',  # Set this to something appropriate.
    name=subscription_name, topic=topic_name)

def callback(message):

future = subscriber.subscribe(subscription_name, callback)

The future returned by the call to subscriber.subscribe can be used to block the current thread until a given condition obtains:

except KeyboardInterrupt:

To learn more, consult the subscriber documentation.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for google-cloud-pubsub, version 0.42.1
Filename, size File type Python version Upload date Hashes
Filename, size google_cloud_pubsub-0.42.1-py2.py3-none-any.whl (115.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size google-cloud-pubsub-0.42.1.tar.gz (110.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page