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

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev37-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mqtasks-0.0.1.dev37.tar.gz
  • Upload date:
  • Size: 11.6 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.dev37.tar.gz
Algorithm Hash digest
SHA256 ed12ccbd3d060a2cd5f21a2b306564ed829b37ec0a32862b8d78889e83a557bb
MD5 448dd6bf6609336419eaafa469f207a1
BLAKE2b-256 2542cdcac70168f5bdaa3b9d2b187ed85224d9976f712ed2447e982ad2d2bddd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev37-py3-none-any.whl
Algorithm Hash digest
SHA256 07e41dbf0ff62701c5e6de12e312528eb6740a427e5bd3c9642ce9d22dc68cc7
MD5 4851a940ad2fdde9ac376111615bfdf6
BLAKE2b-256 b33e2e78468fa7266fd7f9357e6c23625412f4dd37f73fe4c49dc4dd48ea7cba

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