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

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev34-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mqtasks-0.0.1.dev34.tar.gz
Algorithm Hash digest
SHA256 5d5473429bcd1d97101665ecf1406538ca9a5230498090fdf58aae1618199c51
MD5 f4fc1d948fdd64a5b75425c58c3647ef
BLAKE2b-256 8bd52f72553d229e4da11026c785fcdcf54632e76651af8a67a6c03dc727a9fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev34-py3-none-any.whl
Algorithm Hash digest
SHA256 e41e0dc1b16da7d0c33023fd6ed411948f48274adfa586002195c5e6f040dd8b
MD5 d2001a5328eb59d08f676480fcb9c198
BLAKE2b-256 c5cdd33acbfe50d1e6fd1ca8b8142b09f4159395d4ff8c55fe39bef6367becf1

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