Skip to main content

An AsyncIO RabbitMQ Client Library

Project description

aiorabbit is an opinionated AsyncIO RabbitMQ client for Python 3 (3.7+).

Version Build Status Coverage License

Project Goals

  • To create a simple, robust RabbitMQ client library for AsyncIO development in Python 3.

  • To make use of new features and capabilities in Python 3.7+.

  • Remove some complexity in using an AMQP client by:
    • Abstracting away the AMQP channel and use it only as a protocol coordination mechanism inside the client.

    • Remove the nowait keyword to ensure a single round-trip pattern of behavior for client usage.

  • To automatically reconnect when a connection is closed due to an AMQP exception/error.

    When such a behavior is encountered, the exception is raised, but the client continues to operate if the user catches and logs the error.

  • To automatically create a new channel when the channel is closed due to an AMQP exception/error.

    When such a behavior is encountered, the exception is raised, but the client continues to operate if the user catches and logs the error.

  • To ensure correctness of API usage, including values passed to RabbitMQ in AMQ method calls.

Example Use

The following demonstrates an example of using the library to publish a message with publisher confirmations enabled:

import asyncio
import datetime
import uuid

import aiorabbit

RABBITMQ_URL = 'amqps://guest:guest@localhost:5672/%2f'


async def main():
    async with aiorabbit.connect(RABBITMQ_URL) as client:
        await client.confirm_select()
        if not await client.publish(
                'exchange',
                'routing-key',
                'message-body',
                app_id='example',
                message_id=str(uuid.uuid4()),
                timestamp=datetime.datetime.utcnow()):
            print('Publishing failure')

if __name__ == '__main__':
    asyncio.get_event_loop().run_until_complete(main())

Documentation

http://aiorabbit.readthedocs.org

License

Copyright (c) 2019-2023 Gavin M. Roy All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Python Versions Supported

3.7+

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiorabbit-1.0.0.tar.gz (38.7 kB view details)

Uploaded Source

Built Distribution

aiorabbit-1.0.0-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file aiorabbit-1.0.0.tar.gz.

File metadata

  • Download URL: aiorabbit-1.0.0.tar.gz
  • Upload date:
  • Size: 38.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for aiorabbit-1.0.0.tar.gz
Algorithm Hash digest
SHA256 78e931368fa7c3ef242b7653356238c0e24d41afc9439d8f69e61f9ac890c306
MD5 41767cc5f2a83510eee56f675663fb48
BLAKE2b-256 a48868a0b0114347a1b820a859fca3c35b59c32d9aa4d13ef22f73eead6fc918

See more details on using hashes here.

File details

Details for the file aiorabbit-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: aiorabbit-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 30.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for aiorabbit-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2daa2ac7568852201971e653652290fffd23b50b9c842b8a4f105bab299ca95c
MD5 266ab0227de6b28c9716b52742146990
BLAKE2b-256 41042050e9b1c8fdc0275fe96eeff64a37c8e8bf6eefcbf6b714409ef94503ee

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page