A library that provides 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 Distribution
Built Distribution
Hashes for django_celery_beat_endpoint-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74ee860e53be499bf0cca38346bbb9aa1afa0920eab603f7494d1076bfd4e9b9 |
|
MD5 | 12b1bc3d935a94f6fee4b319bc430beb |
|
BLAKE2b-256 | b2d78e332196779cb67cf1bb28d06be8f8a7fbdbf3a676e96066f89a984d6816 |
Hashes for django_celery_beat_endpoint-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be578146cd85498fb246df66d2e5d80708f50b184e2d3c8b17cd0d94e7e8e786 |
|
MD5 | 164768cec468f12ce201fa4e6bbdce42 |
|
BLAKE2b-256 | 0df8a2a7b770a7a93400511dd61ed62c479072babcc6e0651dc64c55d4c43cd8 |