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

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev20-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mqtasks-0.0.1.dev20.tar.gz
Algorithm Hash digest
SHA256 419b2a05421de5edbeecbb4a7905856d582d288a6315c69de4f82ca34d36a530
MD5 1422c19dcb571e17627ec7afb4bc844a
BLAKE2b-256 e4097c4e70ecd72f2d9c61e747d6bf9a46bd67135e8005f04407ad146bef6a33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev20-py3-none-any.whl
Algorithm Hash digest
SHA256 1fa86f482fdae00e8684f160b0bdc06bbcf5c531cc1a2207d5954e2a2a26d8ba
MD5 a864a1b01e52c7026687fb99ef25820f
BLAKE2b-256 1fb9ba8afbf2b6ece5ae118613087f10994d3243c0ca8ccc326317d15892028c

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