A library that provides basic status and tasks endpoint for Django Celery Beat.
Project description
Django Celery Beat Endpoint
A library that provides basic status
and tasks
endpoint for Django Celery Beat.
Inspired by vintasoftware/django-celerybeat-status
Requirements
Install
pip install django-celery-beat-endpoint
✨🍰✨
Or you can use pip install git+https://github.com/ZhaoQi99/django-celery-beat-endpoint.git
install latest version.
Usage
Quick start
Just edit proj/celery.py
, and replace Celery
with AwareCelery
from django_celery_beat_endpoint.celery import AwareCelery
app = AwareCelery("proj")
# Or
from django_celery_beat_endpoint.celery import AwareCelery as Celery
app = Celery("proj")
Settings
You can easily configure lower case setting by referring Configuration and defaults.
Or you can use a CELERY_
prefix uppercase setting and loading configuration from the Django settings module.
- beat_port / CELERY_BEAT_PORT - port for http server
Default: 8005
- http_server / CELERY_BEAT_HTTP_SERVER - HTTP server class
Default: "django_celery_beat_endpoint.backends:HTTPServer"
API
- /status
{
"status": "OK"
}
- /tasks
[
{
"name": "proj.tasks.add",
"task": "",
"args": "()",
"last_run_at": "2024-06-18 20:00:00",
"schedule": "<freq: 1.00 minute>",
"kwargs": "{}",
"is_due": true,
"next_excecution": "2024-06-18 20:00:10"
}
]
Roadmap
- Support more server backends, such as Tornado, Flask and FastAPI.
License
GNU General Public License v3.0
Author
- Qi Zhao(zhaoqi99@outlook.com)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for django_celery_beat_endpoint-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e70c11ff2d09b90489192aa3b5e0c2b38d23f4c1d75a4e2f3b1ec9527de6ac35 |
|
MD5 | 22f90490f89c6168bc7e95233737a06f |
|
BLAKE2b-256 | 1472ea8fa868a1e3e8b150286a6da5a174122d4cb945bcb24e6d17ac41f0b0ab |