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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mqtasks-0.0.1.dev38.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.dev38.tar.gz
Algorithm Hash digest
SHA256 7be0b9319f9ee59b9513e4c268ce8fb1185aab86bb559f84dd04a598fa4ea104
MD5 aa3ef8b4a3cc85abc07c8a9394d415b2
BLAKE2b-256 0bfd6e9e365d14740bc2d650ca54ffb9abebfa5ee1253195110324905b0e76cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev38-py3-none-any.whl
Algorithm Hash digest
SHA256 14fec3117c527094e3d7017a75f7665cd0a946ee7b89fb783907d965ae107cfb
MD5 0815ca2391bf903118cbd3418c0d2608
BLAKE2b-256 6e9ffd45fd8800603ba6cc34e97305f49d1b6e52b8404801444aecfb48066be6

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