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

Uploaded Source

Built Distribution

mqtasks-0.0.1.dev12-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mqtasks-0.0.1.dev12.tar.gz
  • Upload date:
  • Size: 8.0 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.dev12.tar.gz
Algorithm Hash digest
SHA256 12b60a0f69926b08532af43f72169ac22589e5399456441d81618c5d71a15780
MD5 864af4937d2bf4fd404677affc6767ef
BLAKE2b-256 df97ee930b88bba2c5c838bc3e331406cea093840377128360ac599e8f18e2dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mqtasks-0.0.1.dev12-py3-none-any.whl
Algorithm Hash digest
SHA256 38b4b3817fe7ffae5b8af8cde94fffd12731fafbf16a19df4ac92ea298d4b8c8
MD5 36d744b5aa3e032267f48e99859f52db
BLAKE2b-256 0bea8f8bfbca6ea4c869a1fb303d0cde12a336c3ce4f119ea80ef532ecf172e7

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