simple-module-background-tasks 0.0.8

Celery + Redis task queue with admin UI for monitoring and retrying failed/stuck tasks

simple_module_background_tasks

Celery + Redis background-task module for simple_module apps. Provides a pre-configured Celery instance, a task registration hook, and an admin UI for monitoring + retrying failed/stuck tasks.

Install

pip install simple_module_background_tasks

Requires a Redis broker — set SM_CELERY_BROKER_URL (default redis://localhost:6379/0).

What it provides

• register_background_tasks() module hook — modules declare tasks here; the registry wires them into the Celery app at boot.
• Admin UI at /background-tasks/admin — list recent runs, retry failed, inspect tracebacks.
• Shared Celery app accessible via from background_tasks import celery_app (import name background_tasks, distribution name simple_module_background_tasks).

Usage

Declare a task in a module:

# modules/reports/reports/tasks.py
from background_tasks import celery_app   # type: ignore[import-not-found]


@celery_app.task(name="reports.generate")
def generate_report(report_id: int) -> None:
    ...

Register it:

class ReportsModule(ModuleBase):
    meta = ModuleMeta(name="reports", depends_on=["background_tasks"])

    def register_background_tasks(self):
        from . import tasks  # noqa: F401 — side-effect: registers tasks

Enqueue from an endpoint:

generate_report.delay(report_id=42)

Run a worker locally:

uv run celery -A background_tasks.celery_app worker --loglevel=info

Depends on

• simple_module_core, simple_module_db, simple_module_hosting
• celery[redis]>=5.4, redis>=5

License

MIT — see LICENSE.