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

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev24-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mqtasks-0.0.1.dev24.tar.gz
  • Upload date:
  • Size: 8.9 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.dev24.tar.gz
Algorithm Hash digest
SHA256 82055bee376872f71879a918d5edf374b3bf1e55d0c0204f83f4b8a4cd6b5f51
MD5 3815b8d504c6b9c677216634561527a3
BLAKE2b-256 ad969863e3e718eb2d3907a5eeef25f839b85af3c1ad69c5f189cede16b8b4b4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev24-py3-none-any.whl
Algorithm Hash digest
SHA256 20c9f1fea3942fb33779f196127b224d42fd9003312714052244d7ed38d6117a
MD5 394bcafd6f7a4cf41944801215f33d78
BLAKE2b-256 bc02c13579fa67b5248209eb199231def812d186967b148678dac118e79a3da3

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