gax-google-pubsub-v1

GAX library for the Google Pubsub API

gax-google-pubsub-v1 uses google-gax_ (Google API extensions) to provide an easy-to-use client library for the Google Pubsub API_ (v1) defined in the googleapis_ git repository

.. _googleapis: https://github.com/googleapis/googleapis/tree/master/google/pubsub/v1 .. _google-gax: https://github.com/googleapis/gax-python .. _Google Pubsub API: https://developers.google.com/apis-explorer/?hl=en_US#p/pubsub/v1/

Getting started

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

Setup 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:

.. code-block:: console

    $ gcloud beta auth application-default login

or

.. code-block:: console

    $ gcloud auth login

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

.. _Google Cloud SDK: https://cloud.google.com/sdk/
.. _gcloud beta auth application-default login: https://cloud.google.com/sdk/gcloud/reference/beta/auth/application-default/login


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.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/


Mac/Linux
~~~~~~~~~~

.. code-block:: console

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


Windows
~~~~~~~

.. code-block:: console

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


At this point you are all set to continue.