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.run_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.dev26.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev26-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mqtasks-0.0.1.dev26.tar.gz
Algorithm Hash digest
SHA256 03d6f41f2892ce1b8d7d1384eef60355ca18249ced42f1ca3a6dd85975fef5e1
MD5 a8c18814ed33998dbf29b3af317db7ac
BLAKE2b-256 1b80e444e10bed6e44f6b450fcf7c9d9df817091f65bb66922ff0c8f42bbc652

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev26-py3-none-any.whl
Algorithm Hash digest
SHA256 bcad487b781db763e3384283dd4f191248027a1ab0e03b38482cb5a18af64c3c
MD5 15dea2f9c18778f18d551ad9017bacee
BLAKE2b-256 e57aca8ea61ce54b53a5cc35bbedee39bea531683f440cf6db8af3540567f986

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