Getting started

gax-google-pubsub-v1 will allow you to connect to the Google Pubsub API and access all its methods. In order to achieve this, you need to set up authentication as well as install the library locally.

Installation

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.

Mac/Linux

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

Windows

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install gax-google-pubsub-v1

Using the API

Authentication

To authenticate all your API calls, first install and setup the Google Cloud SDK. Once done, you can then run the following command in your terminal:

$ gcloud beta auth application-default login

or

$ gcloud auth login

Please see gcloud beta auth application-default login document for the difference between these commands.


At this point you are all set to continue.

Examples

To see example usage, please read through the API reference. The documentation for each API method includes simple examples.