Skip to content

Quick Start

This guide walks you through defining tasks, enqueueing jobs, running a worker, and opening the dashboard — all in under 5 minutes.

1. Start Redis

docker run -d -p 6379:6379 redis:7

2. Define tasks

Create tasks.py:

from aioq import Aarq
from aioq.backends import RedisBroker

broker = RedisBroker(url="redis://localhost:6379")
app = Aarq(broker=broker)


@app.task(queue="default", retries=3, retry_delay=5.0)
async def add(ctx, a: int, b: int) -> int:
    print(f"[add] {a} + {b} = {a + b}")
    return a + b


@app.task(queue="email", save_result=True)
async def send_email(ctx, to: str, subject: str) -> dict:
    print(f"[send_email] to={to}")
    return {"status": "sent", "to": to}

3. Enqueue jobs

# enqueue.py
import asyncio
from tasks import broker, add, send_email


async def main():
    async with broker:
        job = await add.enqueue(1, 2)
        print(f"Enqueued add: {job.id}")

        job = await send_email.enqueue(to="user@example.com", subject="Hello!")
        print(f"Enqueued send_email: {job.id}")

        # Deferred — runs after 30 seconds
        job = await add.enqueue(10, 20, defer_by=30)
        print(f"Enqueued deferred add: {job.id}")


asyncio.run(main())

python enqueue.py

4. Run a worker

aioq worker tasks:app

The worker will process both queues and print results as jobs complete.

To consume specific queues:

aioq worker tasks:app -q default -q email --concurrency 20

5. Open the dashboard

aioq dashboard tasks:app --port 8080

Navigate to http://localhost:8080 to see:

  • Live queue stats updated every 2 seconds
  • A list of all jobs with their status
  • Individual job detail pages with retry/cancel buttons

What's next?