imavis/stomp.py

“stomp.py” is a Python client library for accessing messaging servers (such as ActiveMQ or RabbitMQ) using the STOMP protocol (versions 1.0, 1.1 and 1.2). It can also be run as a standalone, command-line client for testing.

stomp.py

"stomp.py" is a Python client library for accessing messaging servers (such as ActiveMQ, Artemis or RabbitMQ) using the STOMP protocol (STOMP v1.0, STOMP v1.1 and STOMP v1.2). It can also be run as a standalone, command-line client for testing. NOTE: Stomp.py has officially ended support for Python2.x. See python3statement.org for more information.

• Quick Start
• Documentation and Resources
• Testing

Quick Start

You can connect to a message broker running on the local machine, and send a message using the following example.

import stomp

conn = stomp.Connection()
conn.connect('admin', 'password', wait=True)
conn.send(body=' '.join(sys.argv[1:]), destination='/queue/test')
conn.disconnect()

Documentation and Resources

• Main documentation
• API documentation (see stomp.github.io for details on the STOMP protocol itself)
• A basic example of using stomp.py with a message listener can be found in the quick start section of the main documentation
• Description of the command-line interface
• Travis for continuous integration builds
• Current test coverage report
• PyPi stomp.py page

The current version of stomp.py supports:

• Python 3.x (Python2 support ended as of Jan 2020)
• STOMP version 1.0, 1.1 and 1.2

There is also legacy 3.1.7 version using the old 3-series code (see 3.1.7 on PyPi and 3.1.7 on GitHub). This is no longer supported, but (at least as of 2018) there were still a couple of reports of this version still being used in the wild.

Note: stomp.py now follows semantic versioning:

• MAJOR version for incompatible API changes,
• MINOR version for functionality added in a backwards compatible manner, and
• PATCH version for backwards compatible bug fixes.

Testing

stomp.py has been perfunctorily tested on:

• Pivotal RabbitMQ (test_rabbitmq.py)
• Apache ActiveMQ (test_activemq.py)
• Apache ActiveMQ Artemis (test_artemis.py)
• stompserver (test_stompserver.py)

For testing locally, you'll need to install docker (or podman). Once installed:

1. Install dependencies:

   poetry install

2. Create the docker (or podman) image:

   make docker-image (or make podman-image)

3. Run the container:

   make run-docker (or make run-podman)

4. Run stomp.py unit tests:

   make test

5. Cleanup the container afterwards if you don't need it any more:

   make remove-docker (or make remove-podman)

If you want to connect to the test services locally (other than from the included tests), you'll want to add test domain names to your hosts file like so:

172.17.0.2 my.example.com

172.17.0.2 my.example.org

172.17.0.2 my.example.net

If you're using podman and you want to access services via their private IP addresses, you'll want to run your commands with:

podman unshare --rootless-netns <command>

so that <command> has access to the private container network. Service ports are also exposed to the host and can be accessed directly.