AMQPStorm Documentation

Thread-safe Python RabbitMQ Client & Management library.

Installation

The latest version can be installed using pip and is available at pypi here

pip install amqpstorm

You can also install AMQPStorm with the management dependencies using.

pip install amqpstorm[management]

You can also install AMQPStorm with the pool dependencies using.

pip install amqpstorm[pool]

Basic Example

with amqpstorm.Connection('rmq.amqpstorm.io', 'guest', 'guest') as connection:
    with connection.channel() as channel:
        channel.queue.declare('fruits')
        message = amqpstorm.Message.create(
            channel, body='Hello RabbitMQ!', properties={
                'content_type': 'text/plain'
            })
        message.publish('fruits')

Additional Examples

A wide verity of examples are available on Github at here

Usage

• Connection
  • Connection
    • Connection.channels
    • Connection.fileno
    • Connection.is_blocked
    • Connection.max_allowed_channels
    • Connection.max_frame_size
    • Connection.server_properties
    • Connection.socket
    • Connection.channel()
    • Connection.check_for_errors()
    • Connection.close()
    • Connection.open()
• UriConnection
  • UriConnection
• Channel
  • Channel
    • Channel.basic
    • Channel.exchange
    • Channel.queue
    • Channel.tx
    • Channel.build_inbound_messages()
    • Channel.close()
    • Channel.check_for_errors()
    • Channel.check_for_exceptions()
    • Channel.confirm_deliveries()
    • Channel.process_data_events()
    • Channel.start_consuming()
    • Channel.stop_consuming()
• Channel.Basic
  • Basic
    • Basic.qos()
    • Basic.get()
    • Basic.recover()
    • Basic.consume()
    • Basic.cancel()
    • Basic.publish()
    • Basic.ack()
    • Basic.nack()
    • Basic.reject()
• Channel.Exchange
  • Exchange
    • Exchange.declare()
    • Exchange.delete()
    • Exchange.bind()
    • Exchange.unbind()
• Channel.Queue
  • Queue
    • Queue.declare()
    • Queue.delete()
    • Queue.purge()
    • Queue.bind()
    • Queue.unbind()
• Channel.Tx
  • Tx
    • Tx.select()
    • Tx.commit()
    • Tx.rollback()
• Exceptions
  • AMQPError
    • AMQPError.documentation
    • AMQPError.error_code
    • AMQPError.error_type
  • AMQPConnectionError
  • AMQPChannelError
  • AMQPMessageError
  • AMQPInvalidArgument
• Message
  • Message
    • Message.create()
    • Message.body
    • Message.channel
    • Message.method
    • Message.properties
    • Message.ack()
    • Message.nack()
    • Message.reject()
    • Message.publish()
    • Message.app_id
    • Message.message_id
    • Message.content_encoding
    • Message.content_type
    • Message.correlation_id
    • Message.delivery_mode
    • Message.timestamp
    • Message.priority
    • Message.reply_to
    • Message.message_type
    • Message.expiration
    • Message.user_id
    • Message.redelivered
    • Message.delivery_tag
    • Message.json()

Management API Usage

• Management Api
  • ManagementApi
    • ManagementApi.basic
    • ManagementApi.channel
    • ManagementApi.connection
    • ManagementApi.exchange
    • ManagementApi.queue
    • ManagementApi.user
    • ManagementApi.aliveness_test()
    • ManagementApi.nodes()
    • ManagementApi.overview()
    • ManagementApi.top()
    • ManagementApi.whoami()
  • Basic
    • Basic.publish()
    • Basic.get()
  • Channel
    • Channel.get()
    • Channel.list()
  • Connection
    • Connection.get()
    • Connection.list()
    • Connection.close()
  • Exchange
    • Exchange.get()
    • Exchange.list()
    • Exchange.declare()
    • Exchange.delete()
    • Exchange.bindings()
    • Exchange.bind()
    • Exchange.unbind()
  • Queue
    • Queue.get()
    • Queue.list()
    • Queue.declare()
    • Queue.delete()
    • Queue.purge()
    • Queue.bindings()
    • Queue.bind()
    • Queue.unbind()
  • User
    • User.get()
    • User.list()
    • User.create()
    • User.delete()
    • User.get_permission()
    • User.get_permissions()
    • User.set_permission()
    • User.delete_permission()
  • VirtualHost
    • VirtualHost.get()
    • VirtualHost.list()
    • VirtualHost.create()
    • VirtualHost.delete()
    • VirtualHost.get_permissions()
• Management Api Exceptions
  • ApiConnectionError
  • ApiError

Examples

• Flask RPC Client
• Robust Consumer
• Simple Consumer
• Simple Publisher
• Simple RPC Client
• Simple RPC Server
• SSL connection

Pool Examples

• Pool Example
• SSL Pool Example

Management Examples

• RabbitMQ Aliveness Test
• Create a RabbitMQ User
• Create a RabbitMQ Virtual Host
• Create a RabbitMQ Queue
• Delete a RabbitMQ Queue
• Check if a RabbitMQ Queue exists
• Get a RabbitMQ User
• List RabbitMQ Queues
• Get a RabbitMQ Overview

Issues

Please report any issues on Github here

Source

AMQPStorm source code is available on Github here

Indices and tables

• Index

• Module Index

• Search Page