Skip to main content

Wrapper for the PIKA for asyncio and humans.

Project description

ReadTheDocs Coveralls Travis CI Latest Version https://img.shields.io/pypi/wheel/aio-pika.svg https://img.shields.io/pypi/pyversions/aio-pika.svg https://img.shields.io/pypi/l/aio-pika.svg

Wrapper for the PIKA for asyncio and humans. See examples and the tutorial in documentation.

If you are newcomer in the RabbitMQ let’s start the adopted official RabbitMQ tutorial

Features

  • Completely asynchronous API.

  • Object oriented API.

  • Transparent auto-reconnects with complete state recovery with connect_robust (e.g. declared queues or exchanges, consuming state and bindings).

  • Python 3.4+ compatible (include 3.6).

  • Transparent publisher confirms support

  • Transactions support

Installation

pip install aio-pika

Usage example

import asyncio
from aio_pika import connect_robust, Message


async def main(loop):
    connection = await connect_robust("amqp://guest:guest@127.0.0.1/", loop=loop)

    queue_name = "test_queue"
    routing_key = "test_queue"

    # Creating channel
    channel = await connection.channel()

    # Declaring exchange
    exchange = await channel.declare_exchange('direct', auto_delete=True)

    # Declaring queue
    queue = await channel.declare_queue(queue_name, auto_delete=True)

    # Binding queue
    await queue.bind(exchange, routing_key)

    await exchange.publish(
        Message(
            bytes('Hello', 'utf-8'),
            content_type='text/plain',
            headers={'foo': 'bar'}
        ),
        routing_key
    )

    # Receiving message
    incoming_message = await queue.get(timeout=5)

    # Confirm message
    incoming_message.ack()

    await queue.unbind(exchange, routing_key)
    await queue.delete()
    await connection.close()


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

See another examples and the tutorial in documentation.

For contributors

You feel free to create pull request, but you should describe your cases and add some examples.

The changes should follow simple rules:

  • When your changes breaks public API you must increase the major version.

  • When your changes is safe for public API (e.g. added an argument with default value)

  • You have to add test cases (see tests/ folder)

  • You must add docstrings

  • You feel free to add yourself to “thank’s to” section

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

aio-pika-1.3.5.tar.gz (20.9 kB view details)

Uploaded Source

Built Distribution

aio_pika-1.3.5-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

Details for the file aio-pika-1.3.5.tar.gz.

File metadata

  • Download URL: aio-pika-1.3.5.tar.gz
  • Upload date:
  • Size: 20.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for aio-pika-1.3.5.tar.gz
Algorithm Hash digest
SHA256 3ab0da23578233415a91e0a18ef12b925c2632fa90d42b1ed319908727d71ee6
MD5 46bdc7d732d47b2cd526e4b421d2cfd8
BLAKE2b-256 33ac6a69578f0ab9f7ca4f00732abfd7e910238197664dea829c09988f259608

See more details on using hashes here.

File details

Details for the file aio_pika-1.3.5-py3-none-any.whl.

File metadata

File hashes

Hashes for aio_pika-1.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 da8fa213a778acee7438e306d4989fda71d2b195e47018e6aed7b2f1ee085843
MD5 5ec082cd0878e33653ad1b68b90b937d
BLAKE2b-256 3d484d2acd3b6d92fa048a57b18751e93cfd7fde32d22d29d0be8da40f39d61a

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