Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dldevinc/paper-rq
An administrative interface for managing RQ tasks in Paper Admin
https://github.com/dldevinc/paper-rq
Last synced: about 1 month ago
JSON representation
An administrative interface for managing RQ tasks in Paper Admin
- Host: GitHub
- URL: https://github.com/dldevinc/paper-rq
- Owner: dldevinc
- License: bsd-3-clause
- Created: 2021-04-12T11:17:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-13T14:32:55.000Z (12 months ago)
- Last Synced: 2024-11-29T14:56:44.367Z (about 1 month ago)
- Language: Python
- Size: 121 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# paper-rq
An administrative interface for managing RQ tasks in Paper Admin.
⚠ Default `rq.scheduler` is not supported! Use [rq-scheduler](https://github.com/rq/rq-scheduler) instead.
[](https://pypi.org/project/paper-rq/)
[](https://github.com/dldevinc/paper-rq)
[](https://pypi.org/project/paper-rq/)
## Compatibility
- [`paper-admin`](https://github.com/dldevinc/paper-admin) >= 6.0
- [`django-rq`](https://github.com/rq/django-rq) >= 2.4
- `python` >= 3.7
## Installation
Install the latest release with pip:
```shell
pip install paper-rq
```
Add `paper_rq` to your INSTALLED_APPS in django's `settings.py`:
```python
INSTALLED_APPS = (
# ...
"paper_rq",
)
```
Add `paper_rq` to your `PAPER_MENU`:
```python
from paper_admin.menu import Item
PAPER_MENU = [
# ...
Item(
app="paper_rq",
icon="bi-clock-history",
),
# ...
]
```
Optionally, set `paper_rq.jobs.Job` as your job class:
```python
RQ = {
"JOB_CLASS": "paper_rq.jobs.Job",
# ...
}
```
## Result
[](https://postimg.cc/tsbYd7Lr)
## `job` decorator
The same as RQ's `job` decorator, but it automatically works out
the `connection` argument from RQ_QUEUES. It also respects the
`RQ.DEFAULT_RESULT_TTL` and `RQ.DEFAULT_FAILURE_TTL` settings.
Example:
```python
import time
from paper_rq.decorators import job
@job("paper:default")
def sleep(delay):
time.sleep(delay)
```
```python
sleep.delay(5)
```
## RQ Scheduler
First, ensure that you have the `rq-scheduler` library installed:
```shell
pip install rq-scheduler
```
If you need to run multiple isolated schedulers on the same server, you should
use the class `paper_rq.scheduler.Scheduler`. This class reads the Redis keys
from the `RQ` settings:
```python
# settings.py
RQ = {
"JOB_CLASS": "paper_rq.jobs.Job",
"DEFAULT_RESULT_TTL": "7d",
"DEFAULT_FAILURE_TTL": "30d",
"SCHEDULER_CLASS": "paper_rq.scheduler.Scheduler",
"SCHEDULER_LOCK_KEY": "rq:scheduler-1:scheduler_lock",
"SCHEDULER_JOBS_KEY": "rq:scheduler-1:scheduled_jobs",
}
```