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.dev39.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev39-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mqtasks-0.0.1.dev39.tar.gz
  • Upload date:
  • Size: 11.9 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.dev39.tar.gz
Algorithm Hash digest
SHA256 39192ce74551272a12dca0bccc66bd2522b6f73de3df8c976c5676affebe083c
MD5 2fd7b04bab6be9e37b8eee96a8ffaa11
BLAKE2b-256 2e3850d38bae973f0ca77829c9939cf98c5239cc9a99c1e6fa71764d29d96148

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev39-py3-none-any.whl
Algorithm Hash digest
SHA256 81c214f69628e77d75166c4a0d04c7764595683de75c7480dbecb001eeea6625
MD5 e1296143ebeca72e6dafff4b3f2abf4a
BLAKE2b-256 ff8af112bc160ae2c4f12b53c596c9ef9b2f63fd9e77be833a83f615035c89dc

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