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

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev33-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mqtasks-0.0.1.dev33.tar.gz
  • Upload date:
  • Size: 10.7 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.dev33.tar.gz
Algorithm Hash digest
SHA256 29755edd8e1ea78ff5fb3f8e1c92b0cf245bac62c4e0a60918321dc45d5c363e
MD5 c65dd72c2c5d15c46198795d0ce3b0cf
BLAKE2b-256 ff06a390935538f2003ec4d2500ecbbd78eb29c07f3779abb6c874e60624caee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev33-py3-none-any.whl
Algorithm Hash digest
SHA256 623b4ee725d88e2c0d6c487d9ab994be02c82dcc56e3103770f92db07b7ec1e3
MD5 5c428b37d085769ac69789a91a72eddb
BLAKE2b-256 a49e81a0c5bf38e79c305d8596e0968c5d3f376f2a378627b6fc3e939f4d406e

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