Welcome to SPADE PubSub’s documentation!

SPADE PubSub

https://img.shields.io/pypi/v/spade_pubsub.svg https://img.shields.io/travis/javipalanca/spade_pubsub.svg Documentation Status

SPADE Plugin for PubSub support.

Features

  • TODO

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install SPADE PubSub, run this command in your terminal:

$ pip install spade_pubsub

This is the preferred method to install SPADE PubSub, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for SPADE PubSub can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/javipalanca/spade_pubsub

Or download the tarball:

$ curl -OJL https://github.com/javipalanca/spade_pubsub/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

The PubSub plugin gives agents the ability to create nodes, subscribe to nodes and publish items to nodes following the XEP 0060 (https://xmpp.org/extensions/xep-0060.html).

To use SPADE PubSub in a project:

from spade_pubsub import PubSubMixin
from spade import Agent

class YourAgent(PubSubMixin, Agent):
    # Your code here...

Warning

Mixins MUST be always placed before the Agent class in the inheritance order.

Working with nodes

An agent can create a node where other agents may subscribe in order to receive notifications when new items are published in such node.

Warning

Due to limitations of the XMPP Publish-Subscribe standard, agents MUST be registered in the XMPP server with creation privileges in order to create nodes. (e.g. In Prosody include them in the admin list (admins = {}).

Tip

Note that you MUST substitute PUBSUB_JID with the address of the pubsub component that your XMPP server uses (e.g. “pubsub.localhost)

To create and delete a node in a PubSub server:

await self.agent.pubsub.create(PUBSUB_JID, "Name of the node")
await self.agent.pubsub.delete(PUBSUB_JID, "Name of the node")

To get all nodes from a PubSub server:

list_of_nodes = await self.agent.pubsub.get_nodes(PUBSUB_JID)

To purge all items from a node:

await self.agent.pubsub.purge(PUBSUB_JID, "Name of the node")

Publishing Items to a node

Once a node is created, you can publish information to that node. That information will be received by all subscriptors of the node.

Publish an item:

await self.agent.pubsub.publish(PUBSUB_JID, "Name of the node", "Payload of the item")

Get all published items from a node:

items = await self.agent.pubsub.get_items(PUBSUB_JID, "Name of the node")

Subscribe and unsubscribe:

await self.agent.pubsub.subscribe(PUBSUB_JID, "Name of the node")
await self.agent.pubsub.unsubscribe(PUBSUB_JID, "Name of the node")

Register callback function to receive published items:

def my_callback(self, jid, node, item, message=None):
    # Your code here

# register callback
self.agent.pubsub.set_on_item_published(my_callback)

Get all subscriptions of a node:

list_of_subs = await self.agent.pubsub.get_node_subscriptions(PUBSUB_JID, "Name of the node")

API Documentation

spade_pubsub package

Submodules

spade_pubsub.pubsub module

class spade_pubsub.pubsub.Payload(*args, **kwargs)[source]

Bases: aioxmpp.xso.model.XSO

ATTR_MAP = {}
CHILD_MAP = {}
CHILD_PROPS = OrderedSet([])
COLLECTOR_PROPERTY = None
DECLARE_NS = {None: 'spade.pubsub'}
TAG = ('spade.pubsub', 'payload')
TEXT_PROPERTY
data
class spade_pubsub.pubsub.PubSubMixin[source]

Bases: object

This mixin provides PubSub support to SPADE agents. It must be used as superclass of a spade.Agent subclass.

class PubSubComponent(client)[source]

Bases: object

async create(target_jid: str, target_node: Optional[str] = None)[source]

Create a new node at a service.

Args:

target_jid (str): Address of the PubSub service. target_node (str or None): Name of the PubSub node to create

async delete(target_jid: str, target_node: Optional[str], redirect_uri: Optional[str] = None)[source]

Delete an existing node.

Args:

target_jid (str): Address of the PubSub service. target_node (str or None): Name of the PubSub node to delete. redirect_uri (str or None): A URI to send to subscribers to indicate a replacement for the deleted node.

async get_items(target_jid: str, target_node: Optional[str])[source]

Request all items at a service or collection node.

Args:

target_jid (str): Addressof the PubSub service. target_node (str): Name of the PubSub node.

async get_node_subscriptions(target_jid: str, target_node: Optional[str]) → List[str][source]

Return the subscriptions of other jids with a node.

Args:

target_jid (str): Address of the PubSub service. target_node (str): Name of the node to query

async get_nodes(target_jid: str, target_node: Optional[str] = None)[source]

Request all nodes at a service or collection node.

Args:

target_jid (str): Address of the PubSub service. target_node (str or None): Name of the collection node to query

async notify(target_jid: str, target_node: str)[source]

Notify all subscribers of a node without publishing an item. “Publish” to the node at jid without any item. This merely fans out a notification.

Args:

target_jid (str): Address of the PubSub service. target_node (str): Name of the PubSub node to send a notify from.

async publish(target_jid: str, target_node: str, payload: str, item_id: Optional[str] = None)[source]

Publish an item to a node.

Args:

target_jid (str): Address of the PubSub service. target_node (str): Name of the PubSub node to publish to. payload (str): Payload to publish. item_id (str or None): Item ID to use for the item.

async purge(target_jid: str, target_node: Optional[str])[source]

Delete all items from a node.

Args:

target_jid (str): JID of the PubSub service target_node (str): Name of the PubSub node

async retract(target_jid: str, target_node: str, item_id: str, notify=False)[source]

Retract a previously published item from a node.

Args:

target_jid (str): Address of the PubSub service. target_node (str): Name of the PubSub node to send a notify from. item_id (str): The ID of the item to retract. notify (bool): Flag indicating whether subscribers shall be notified about the retraction.

set_on_item_published(callback)[source]
set_on_item_retracted(callback)[source]
async subscribe(target_jid: str, target_node: Optional[str] = None, subscription_jid: Optional[str] = None, config=None)[source]

Subscribe to a node.

Args:

target_jid (str): Address of the PubSub service. target_node (str): Name of the PubSub node to subscribe to. subscription_jid (str): The address to subscribe to the service. config (Data): Optional configuration of the subscription

async unsubscribe(target_jid: str, target_node: Optional[str] = None, subscription_jid: Optional[str] = None, subid=None)[source]

Unsubscribe from a node.

Args:

target_jid (str): Address of the PubSub service. target_node (str): Name of the PubSub node to unsubscribe from. subscription_jid (str): The address to subscribe from the service. subid (str): Unique ID of the subscription to remove.

Module contents

Top-level package for SPADE PubSub.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/javipalanca/spade_pubsub/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

SPADE PubSub could always use more documentation, whether as part of the official SPADE PubSub docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/javipalanca/spade_pubsub/issues.

If you are proposing a feature:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up spade_pubsub for local development.

  1. Fork the spade_pubsub repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/spade_pubsub.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv spade_pubsub
$ cd spade_pubsub/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 spade_pubsub tests
$ python setup.py test or pytest
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.

  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.

  3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check https://travis-ci.com/javipalanca/spade_pubsub/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests.test_spade_pubsub

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

  • Javi Palanca

Contributors

None yet. Why not be the first?

History

0.1.3 (2021-06-29)

  • Minor bug fixed.

0.1.2 (2021-06-25)

  • First release on PyPI.

Indices and tables