Welcome to cli-proton-python’s documentation!


https://travis-ci.org/rh-messaging/cli-proton-python.svg?branch=master https://badge.fury.io/py/cli-proton-python.svg

Proton Python clients is a collection of reactive messaging test clients built on python-qpid-proton AMQP1.0 based messaging library. cli-proton-python is a part of Unified Messaging Test Clients that offers equivalent functionality when using different programing languages or APIs.

current related projects:


cli-proton-python requires Python v2.6+ to run.

$ pip install cli-proton-python


Using the command line clients (please refer to –help to discover the available options)

$ cli-proton-python-sender --broker-url "username:password@localhost:5672/queue_test" --count 1 --msg-content "text message" --log-msgs dict
$ cli-proton-python-receiver --broker-url "username:password@localhost:5672/queue_test" --count 1 --log-msgs dict

Using in script

import proton
from cli_proton_python import sender

parser = sender.options.SenderOptions()

opts, _ = parser.parse_args()
opts.broker_url = 'username:password@localhost:5672/examples'
opts.count = 1
opts.msg_content = 'text message'
opts.log_msgs = 'dict'

container = proton.reactor.Container(sender.Send(opts))


Documentation Status

Documentation may be found on readthedocs.io: read the docummentation

Indices and tables


v1.0.0 – November 20, 2017

v1.0.1 – November 24, 2017

  • json message output format support added
  • minor documentation and packaging changes
  • API documentation generation

v1.0.2 – February 02, 2018 * address / amqp-to message field support * authentication mechanisms option support * existing bug references added to tests

v1.0.3 – February 05, 2018 * message numbering fix * use anonymous authentication mechanism in p2p tests

v1.0.4 – TBD, not yet live * message group sequence option support