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

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev30-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mqtasks-0.0.1.dev30.tar.gz
  • Upload date:
  • Size: 9.3 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.dev30.tar.gz
Algorithm Hash digest
SHA256 fb07aadb6633e0b778195c75b3c34e915b1d36ea4560d70a1e5e23d153446d0a
MD5 ce123e735224225c9c472637c706b4f9
BLAKE2b-256 3a39aaa1b5507dd7740d52d7fac79fa95017a3029d42d317901029d37d10c2af

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev30-py3-none-any.whl
Algorithm Hash digest
SHA256 79ed079a8bd74e0e43187683c2fd40dc97753907a94c7915a898036a39b2400d
MD5 ecdab1e15f62a79506a726a75f67cdcb
BLAKE2b-256 dc69e864190f0935fee24c875f4bd151420a5f22656a2622eff3e578131f927b

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