# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-django-rq
VERSION=		4.1.1
KEYWORDS=		python
VARIANTS=		v13 v14
SDESC[v13]=		Django integration of Redis Queue (3.13)
SDESC[v14]=		Django integration of Redis Queue (3.14)
HOMEPAGE=		https://python-rq.org/patterns/django/
CONTACT=		Python_Automaton[python@ravenports.com]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPIWHL/d7/32/512dfa80fce6390deb390da9492bcbabc4824b3f4574890e68daac13b2d4
DISTFILE[1]=		django_rq-4.1.1-py3-none-any.whl:main
DIST_SUBDIR=		python-src
DF_INDEX=		1
SPKGS[v13]=		single
SPKGS[v14]=		single

OPTIONS_AVAILABLE=	PY313 PY314
OPTIONS_STANDARD=	none
VOPTS[v13]=		PY313=ON PY314=OFF
VOPTS[v14]=		PY313=OFF PY314=ON

DISTNAME=		django_rq-4.1.1.dist-info

GENERATED=		yes

[PY313].RUN_DEPENDS_ON=			python-Django:single:v13
					python-redis:single:v13
					python-rq:single:v13
[PY313].USES_ON=			python:v13,wheel

[PY314].RUN_DEPENDS_ON=			python-Django:single:v14
					python-redis:single:v14
					python-rq:single:v14
[PY314].USES_ON=			python:v14,wheel

[FILE:2552:descriptions/desc.single]
# Django-RQ

[Build Status]

Django integration with [RQ], a [Redis] based Python queuing library.
[Django-RQ] is a simple app that allows you to configure your queues in
Django's `settings.py` and easily use them in your project.

## Support Django-RQ

If you find `django-rq` useful, please consider supporting its development
via [Tidelift].

## Requirements

- [Django] (4.2+)
- [RQ]

## Installation

- Install `django-rq` (or [download from PyPI]):

```bash
pip install django-rq
```

- Add `django_rq` to `INSTALLED_APPS` in `settings.py`:

```python
INSTALLED_APPS = (
    # other apps
    "django_rq",
)
```

- Configure your queues in Django's `settings.py`:

```python
RQ_QUEUES = {
    'default': {
        'HOST': 'localhost',
        'PORT': 6379,
        'DB': 0,
        'USERNAME': 'some-user',
        'PASSWORD': 'some-password',
        'DEFAULT_TIMEOUT': 360,
        'DEFAULT_RESULT_TTL': 800,
        'REDIS_CLIENT_KWARGS': {    # Eventual additional Redis connection
arguments
            'ssl_cert_reqs': None,
        },
    },
    'with-sentinel': {
        'SENTINELS': [('localhost', 26736), ('localhost', 26737)],
        'MASTER_NAME': 'redismaster',
        'DB': 0,
        # Redis username/password
        'USERNAME': 'redis-user',
        'PASSWORD': 'secret',
        'SOCKET_TIMEOUT': 0.3,
        'CONNECTION_KWARGS': {  # Eventual additional Redis connection
arguments
            'ssl': True
        },
        'SENTINEL_KWARGS': {    # Eventual Sentinel connection arguments
            # If Sentinel also has auth, username/password can be passed
here
            'username': 'sentinel-user',
            'password': 'secret',
        },
    },
    'high': {
        'URL': os.getenv('REDISTOGO_URL', 'redis://localhost:6379/0'),  #
If you're on Heroku
        'DEFAULT_TIMEOUT': 500,
    },
    'low': {
        'HOST': 'localhost',
        'PORT': 6379,
        'DB': 0,
    }
}

RQ_EXCEPTION_HANDLERS = ['path.to.my.handler']  # If you need custom
exception handlers
```

## Admin Integration

_New in Version 4.0_

Django-RQ automatically integrates with Django's admin interface. Once
installed, navigate to `/admin/django_rq/dashboard/` to access:
- Queue statistics and monitoring dashboard
- Job registry browsers (scheduled, started, finished, failed, deferred)
- Worker management
- Prometheus metrics endpoint (if `prometheus_client` is installed)

The views are automatically registered in Django admin and a link to the
dashboard is added to the admin interface's sidebar. If you want to disable


[FILE:122:distinfo]
d10a14eaab06aebd223f0a7e5194d129ea126ac9236125150b2ff86e30f27dea        73412 python-src/django_rq-4.1.1-py3-none-any.whl