https://github.com/Bynder/qpid-bow

Qpid Bow is a higher level client framework for Python 3.6+ to communicate with AMQP/Qpid servers combined with a set of CLI tools to manage a Qpid server.
https://github.com/Bynder/qpid-bow

amqp cli python qpid

Last synced: 7 months ago
JSON representation

Qpid Bow is a higher level client framework for Python 3.6+ to communicate with AMQP/Qpid servers combined with a set of CLI tools to manage a Qpid server.

• Host: GitHub
• URL: https://github.com/Bynder/qpid-bow
• Owner: Bynder
• License: mit
• Archived: true
• Created: 2018-01-03T14:57:47.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-03-28T12:10:16.000Z (over 7 years ago)
• Last Synced: 2025-08-25T22:33:19.256Z (10 months ago)
• Topics: amqp, cli, python, qpid
• Language: Python
• Homepage:
• Size: 72.3 KB
• Stars: 9
• Watchers: 59
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-amqp - qpid-bow - Higher level client framework for Python 3.6+ to communicate with AMQP/Qpid servers combined with a set of CLI tools to manage a Qpid server. (Table of Contents / Tools)

README

          
qpid-bow

========

.. image:: https://travis-ci.org/Bynder/qpid-bow.svg?branch=master

    :target: https://travis-ci.org/Bynder/qpid-bow

.. image:: https://coveralls.io/repos/github/Bynder/qpid-bow/badge.svg?branch=master

    :target: https://coveralls.io/github/Bynder/qpid-bow?branch=master

.. image:: https://readthedocs.org/projects/qpid-bow/badge/?version=latest

    :target: https://qpid-bow.readthedocs.io/en/latest/?badge=latest

    :alt: Documentation Status

Qpid Bow is a higher level client framework for Python 3.6+ to communicate with

AMQP/Qpid servers combined with a set of CLI tools to manage a Qpid server.

With its CLI tools Qpid Bow provides the missing tooling you always wanted

to administrate or debug your Qpid-based AMQP stack. Providing you with the

power to manage queues and exchanges, setup and save routing using YAML files

and various other tools.

As a framework Qpid Bow can provide you with a higher level interface on top of

the low level Qpid Proton library to integrate with AMQP/Qpid queues,

exchanges and Remote Procedure Call (RPC) functionality:

* Simple, callback based receiver, supporting listening for multiple queues.

* RPC calls with automatic temporary queues and callbacks.

* Queue based sender.

* Included Qpid management code for queue/exchange creation.

* Support to run under Python's asyncio event loop with *async def* callbacks.

Requirements

------------

* Python 3.6+

* `python-qpid-proton `_

* `PyYAML `_

Installation

------------

Qpid Bow is available from PyPI:

    $ pip install qpid-bow

Or add qpid-bow to your application's requirements using

``requirements.txt`` / ``setup.py`` / ``Pipfile``.

Testing

-------

Qpid Bow's unit tests need to connect to an actual Apache Qpid server for all

tests to succeed. By default the tests assume a server exists on localhost.

To specify the server address to use for tests use the environment variable:

``AMQP_TEST_SERVERS``

Available tools

---------------

**Queue**

* ``qb queue create`` - Create queues.

* ``qb queue delete`` - Delete queues.

* ``qb queue purge`` - Purge messages from a queue.

* ``qb queue reroute`` - Reroute messages from a queue to an exchange.

* ``qb queue stats`` - Print queue usage statistics and active number of messages.

**Message**

* ``qb message receive`` - Receive messages from a queue or an exchange.

* ``qb message send`` - Send messages to a queue or an exchange.

**Route**

* ``qb route dump`` - View & save exchange -> queue routing.

* ``qb route config`` - Setup exchange -> queue routing from a saved file.

**Connection**

* ``qb connection kill`` - Kill connections from the server.

**Session**

* ``qb session outgoing`` - List outgoing sessions from the server.

Configuration & Environment variables

-------------------------------------

Several options exist to configure Qpid Bow. In order of preference:

**Pass in arguments**

One can always override the used server URL using arguments:

* For the CLI tools, use the ``--broker-url`` command line argument.

* For the library pass in the keyword argument ``server_url``.

**Configure using a dict**

When using Qpid Bow as a library, one can pass in config using a dict to:

``qpid_bow.config.configure``

The dict can contain the following entries:

* ``amqp_url`` - Comma-separated list of main and failover servers to connect to.

* ``username`` - Username to use when no username is provided in the URL.

* ``password`` - Password to use when no password is provided in the URL.

**Environment variables**

The easiest way to configure Qpid Bow's tools and library is to use environment variables.

These variables can be added to your shell's profile and will automatically get picked up.

* ``AMQP_SERVERS`` - Comma-separated list of main and failover servers to connect to.

* ``AMQP_TEST_SERVERS`` - Same as ``AMQP_SERVERS``, used solely for unittests.

example: ``AMQP_SERVERS=amqp://user:pass@192.168.1.1:5672,amqp://user:pass@192.168.1.2:5672``