Skip to main content

This module provides a framework for handling and processing asynchronous tasks through message queues.

Project description

Message Queue Tasks

This module provides a framework for handling and processing asynchronous tasks through message queues.


Overview

  • Utilizes the aio_pika library for AMQP message processing.
  • Offers easy-to-use decorators and methods for defining tasks, producing and consuming them.
  • Built with asynchronous patterns to allow seamless scalability.

Requirements

  • Python 3.11+
  • aio_pika library
  • RabbitMQ or other AMQP broker

Usage

1. Defining a Task

To define a task, instantiate the MqTasks object and use the task decorator:

import mqtasks

mq_tasks = MqTasks(amqp_connection="amqp://localhost", queue_name="my_queue")

@mq_tasks.task(name="my_task")
def my_task_function(ctx: MqTaskContext):
    # Process task
    pass

mq_tasks.run()

2. Sending a Task

Instantiate MqTasksClient and use it to send a task:

import asyncio
import mqtasks

client = MqTasksClient(
    loop=asyncio.get_event_loop(),
    amqp_connection="amqp://localhost"
)

# define channel
channel = await client.queue(queue_name="my_queue")

#
result = await channel.request_task_async(task_name="my_task", body={"message": "hello world"})

Examples:

How to start example:

  • Work dir: ./example
    • cd ./example
  • Start RabbitMQ
    1. docker pull rabbitmq:management
    2. docker run -d --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:management
  • Access the RabbitMQ management web UI:
    • http://localhost:15672/
  • By default, the credentials are:
    • Username: guest
    • Password: guest
  • Server
    • python example_server.py
  • Client
    • python example_client.py

License

MIT License

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

mqtasks-0.0.1.dev41.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev41-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file mqtasks-0.0.1.dev41.tar.gz.

File metadata

  • Download URL: mqtasks-0.0.1.dev41.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.10

File hashes

Hashes for mqtasks-0.0.1.dev41.tar.gz
Algorithm Hash digest
SHA256 b172307b975f65e15aec956e75e94bb3c65465144c36ae8fd38f51f293d2d1a7
MD5 f72d403c549ccbc7969993c12f7a6c0d
BLAKE2b-256 7a28dd525d46d9e031a2188fe959618e7f79303b6a9b20ee95c14fc9b19e388d

See more details on using hashes here.

File details

Details for the file mqtasks-0.0.1.dev41-py3-none-any.whl.

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev41-py3-none-any.whl
Algorithm Hash digest
SHA256 5b827250491883e146e9bc3b966efb4f09fda50702600e6b442b8fd79f404a1b
MD5 5a8e37d173576e2d3b64790ef803edef
BLAKE2b-256 1832739a4e84028c967692f7651ca49bfc9ac5c967e57d5db905de2579f1aa0c

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