Installation¶

Requirements¶

Python 3.12+
Django 6.0+
A supported SQL database: MySQL 8+, PostgreSQL 9.5+, or SQLite

Steps¶

Install the package:
```
pip install steady-queue
```

Add the app to INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    # ...
    "steady_queue",
]

Configure a task backend in settings.py:

TASKS = {
    "default": {
        "BACKEND": "steady_queue.backend.SteadyQueueBackend",
        "QUEUES": ["default"],
        "OPTIONS": {},
    }
}

Run migrations:
```
python manage.py migrate
```
Start the worker on your server:
```
python manage.py steady_queue
```

That’s it! Tasks decorated with @task() will now be processed by Steady Queue.

For larger projects you may want to configure a dedicated database for Steady Queue. See Database configuration in the configuration guide.