Skip to content

Reference

Complete API, CLI, and configuration docs. Look-up material - not designed to be read end-to-end. If you are learning Soniq for the first time, the tutorial is a better starting point.

Python API

  • Soniq - the application object
  • Jobs - the @app.job decorator and enqueue surface
  • Worker - run_worker and worker configuration
  • Hooks - before_job, after_job, on_error

CLI

  • Commands - setup, worker, scheduler, dead-letter, status, inspect, dashboard

Operational reference

  • Dead-letter queue - how the DLQ works and how to inspect it
  • Glossary - one-paragraph definitions for the words the docs use

Migration

  • Migrating to Soniq - tradeoffs and shared facts
  • From Celery - concept map, retry/result/Beat equivalents, module-at-a-time sequence
  • From RQ - concept map, four-state lifecycle vs registries, mechanical rewrite

Dashboard

  • Overview - the bundled web UI for inspecting queues