google.pubsub

google.pubsub#

Description#

Publishes and subscribes to Google Pub/Sub topics.

You’ll need a Google Cloud active project and a set of credentials to use this plugin:

  1. Create a project on the Google Cloud console if you don’t have one already.

  2. In the Google Cloud API console create a new service account key. Select “New Service Account”, choose the role “Pub/Sub Editor” and leave the key type as JSON.

  3. Download the JSON service credentials file. By default Platypush will look for the credentials file under <WORKDIR>/credentials/google/pubsub.json.

Configuration#

google.pubsub:
  # [Optional]
  # Path to the JSON credentials file for Google
  # pub/sub (default: ``~/.credentials/platypush/google/pubsub.json``)
  # credentials_file: /var/lib/platypush/credentials/google/pubsub.json  # type=str

  # [Optional]
  # List of topics to subscribe. You can either specify the
  # full topic name in the format
  # ``projects/<project_id>/topics/<topic_name>``, where
  # ``<project_id>`` must be the ID of your Google Pub/Sub project, or
  # just ``<topic_name>`` - in such case it's implied that you refer to
  # the ``topic_name`` under the ``project_id`` of your service
  # credentials.
  # topics: ()  # type=Iterable[str]

  # [Optional]
  # How often the `RunnablePlugin.loop <https://docs.platypush.tech/platypush/plugins/.html#platypush.plugins.RunnablePlugin.loop>`_ function should be
  # executed (default: 15 seconds). *NOTE*: For back-compatibility
  # reasons, the `poll_seconds` argument is also supported, but it's
  # deprecated.
  # poll_interval: 15  # type=Optional[float]

  # [Optional]
  # How long we should wait for any running
  # threads/processes to stop before exiting (default: 5 seconds).
  # stop_timeout: 5  # type=Optional[float]

  # [Optional]
  # If set to True then the plugin will not monitor
  # for new events. This is useful if you want to run a plugin in
  # stateless mode and only leverage its actions, without triggering any
  # events. Defaults to False.
  # disable_monitor: False  # type=bool

Dependencies#

pip

pip install google-cloud-pubsub oauth2client google-auth google-api-python-client httplib2

Alpine

apk add py3-httplib2 py3-oauth2client py3-google-api-python-client py3-google-auth

Debian

apt install python3-google-auth python3-oauth2client python3-httplib2

Fedora

yum install python-oauth2client python-google-auth python-httplib2 python-google-api-client

Arch Linux

pacman -S python-google-api-python-client python-google-auth python-httplib2 python-oauth2client

Triggered events#

Actions#

Module reference#

class platypush.plugins.google.pubsub.GooglePubsubPlugin(credentials_file: str = '/var/lib/platypush/credentials/google/pubsub.json', topics: Iterable[str] = (), **kwargs)[source]#

Bases: RunnablePlugin

Publishes and subscribes to Google Pub/Sub topics.

You’ll need a Google Cloud active project and a set of credentials to use this plugin:

  1. Create a project on the Google Cloud console if you don’t have one already.

  2. In the Google Cloud API console create a new service account key. Select “New Service Account”, choose the role “Pub/Sub Editor” and leave the key type as JSON.

  3. Download the JSON service credentials file. By default Platypush will look for the credentials file under <WORKDIR>/credentials/google/pubsub.json.

__init__(credentials_file: str = '/var/lib/platypush/credentials/google/pubsub.json', topics: Iterable[str] = (), **kwargs)[source]#
Parameters:

  • credentials_file – Path to the JSON credentials file for Google pub/sub (default: ~/.credentials/platypush/google/pubsub.json)

  • topics – List of topics to subscribe. You can either specify the full topic name in the format projects/<project_id>/topics/<topic_name>, where <project_id> must be the ID of your Google Pub/Sub project, or just <topic_name> - in such case it’s implied that you refer to the topic_name under the project_id of your service credentials.

publish(topic: str, msg, **kwargs)[source]#

Publish a message to a topic

Parameters:

  • topic – Topic/channel where the message will be delivered. You can either specify the full topic name in the format projects/<project_id>/topics/<topic_name>, where <project_id> must be the ID of your Google Pub/Sub project, or just <topic_name> - in such case it’s implied that you refer to the topic_name under the project_id of your service credentials.

  • msg – Message to be sent. It can be a list, a dict, or a Message object

  • kwargs – Extra arguments to be passed to .publish()

send_message(topic: str, msg, **kwargs)[source]#

Alias for publish()

subscribe(topic: str)[source]#

Subscribe to a topic.

Parameters:

topic – Topic/channel where the message will be delivered. You can either specify the full topic name in the format projects/<project_id>/topics/<topic_name>, where <project_id> must be the ID of your Google Pub/Sub project, or just <topic_name> - in such case it’s implied that you refer to the topic_name under the project_id of your service credentials.

unsubscribe(topic: str)[source]#

Unsubscribe from a topic.

Parameters:

topic – Topic/channel where the message will be delivered. You can either specify the full topic name in the format projects/<project_id>/topics/<topic_name>, where <project_id> must be the ID of your Google Pub/Sub project, or just <topic_name> - in such case it’s implied that you refer to the topic_name under the project_id of your service credentials.

Platypush documentation