django-celery-beat-endpoint


Namedjango-celery-beat-endpoint JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://github.com/ZhaoQi99/django-celery-beat-endpoint
SummaryA library that provides basic status and tasks endpoint for Django Celery Beat.
upload_time2024-06-21 03:56:33
maintainerNone
docs_urlNone
authorQi Zhao
requires_python>=3.6
licenseNone
keywords django celery beat status endpoint
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Django Celery Beat Endpoint
[![Python version](https://img.shields.io/pypi/pyversions/django-celery-beat-endpoint.svg?logo=python)](https://pypi.python.org/pypi/django-celery-beat-endpoint)
[![PyPI package](https://img.shields.io/pypi/v/django-celery-beat-endpoint.svg)](https://pypi.python.org/pypi/django-celery-beat-endpoint)
[![PyPI download](https://img.shields.io/pypi/dm/django-celery-beat-endpoint.svg)](https://pypi.python.org/pypi/django-celery-beat-endpoint)
[![GitHub](https://img.shields.io/github/license/ZhaoQi99/django-celery-beat-endpoint)](https://github.com/ZhaoQi99/django-celery-beat-endpoint/blob/main/LICENSE)
![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/ZhaoQi99/django-celery-beat-endpoint)

A library that provides basic `status` and `tasks` endpoint for Django Celery Beat.

Inspired by [vintasoftware/django-celerybeat-status](https://github.com/vintasoftware/django-celerybeat-status)

## Requirements
* Python >= 3.6
* [Django](https://docs.djangoproject.com/)
* [Celery](https://docs.celeryq.dev/)

## Install
```shell
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`

```python
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](https://docs.celeryq.dev/en/stable/userguide/configuration.html).

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
```json
{
  "status": "OK"
}
```

* /tasks
```json
[
  {
    "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_execution": "2024-06-18 20:00:10"
  }
]
```
## Roadmap
- [ ] Support more server backends, such as Tornado, Flask and FastAPI.

## License
[GNU General Public License v3.0](https://github.com/ZhaoQi99/django-celery-beat-endpoint/blob/main/LICENSE)

## Author
* Qi Zhao([zhaoqi99@outlook.com](mailto:zhaoqi99@outlook.com))

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ZhaoQi99/django-celery-beat-endpoint",
    "name": "django-celery-beat-endpoint",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "django, celery, beat, status, endpoint",
    "author": "Qi Zhao",
    "author_email": "zhaoqi99@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/fe/2c/b7d5f5b9c0202f693ebea6701b18622741b0c8dcd724290f80f0e61ce1bc/django_celery_beat_endpoint-0.1.2.tar.gz",
    "platform": null,
    "description": "# Django Celery Beat Endpoint\n[![Python version](https://img.shields.io/pypi/pyversions/django-celery-beat-endpoint.svg?logo=python)](https://pypi.python.org/pypi/django-celery-beat-endpoint)\n[![PyPI package](https://img.shields.io/pypi/v/django-celery-beat-endpoint.svg)](https://pypi.python.org/pypi/django-celery-beat-endpoint)\n[![PyPI download](https://img.shields.io/pypi/dm/django-celery-beat-endpoint.svg)](https://pypi.python.org/pypi/django-celery-beat-endpoint)\n[![GitHub](https://img.shields.io/github/license/ZhaoQi99/django-celery-beat-endpoint)](https://github.com/ZhaoQi99/django-celery-beat-endpoint/blob/main/LICENSE)\n![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/ZhaoQi99/django-celery-beat-endpoint)\n\nA library that provides basic `status` and `tasks` endpoint for Django Celery Beat.\n\nInspired by [vintasoftware/django-celerybeat-status](https://github.com/vintasoftware/django-celerybeat-status)\n\n## Requirements\n* Python >= 3.6\n* [Django](https://docs.djangoproject.com/)\n* [Celery](https://docs.celeryq.dev/)\n\n## Install\n```shell\npip install django-celery-beat-endpoint\n\u2728\ud83c\udf70\u2728\n```\nOr you can use `pip install git+https://github.com/ZhaoQi99/django-celery-beat-endpoint.git\n` install latest version.\n\n## Usage\n### Quick start\nJust edit `proj/celery.py`, and replace `Celery` with `AwareCelery`\n\n```python\nfrom django_celery_beat_endpoint.celery import AwareCelery\napp = AwareCelery(\"proj\")\n# Or\nfrom django_celery_beat_endpoint.celery import AwareCelery as Celery\napp = Celery(\"proj\")\n\n```\n### Settings\nYou can easily configure lower case setting by referring [Configuration and defaults](https://docs.celeryq.dev/en/stable/userguide/configuration.html).\n\nOr you can use a `CELERY_` prefix uppercase setting and loading configuration from the Django settings module.\n\n* beat_port / CELERY_BEAT_PORT - port for http server\n    > Default: 8005\n* http_server / CELERY_BEAT_HTTP_SERVER - HTTP server class\n    > Default: \"django_celery_beat_endpoint.backends:HTTPServer\"\n\n### API\n* /status\n```json\n{\n  \"status\": \"OK\"\n}\n```\n\n* /tasks\n```json\n[\n  {\n    \"name\": \"proj.tasks.add\",\n    \"task\": \"\",\n    \"args\": \"()\",\n    \"last_run_at\": \"2024-06-18 20:00:00\",\n    \"schedule\": \"<freq: 1.00 minute>\",\n    \"kwargs\": \"{}\",\n    \"is_due\": true,\n    \"next_execution\": \"2024-06-18 20:00:10\"\n  }\n]\n```\n## Roadmap\n- [ ] Support more server backends, such as Tornado, Flask and FastAPI.\n\n## License\n[GNU General Public License v3.0](https://github.com/ZhaoQi99/django-celery-beat-endpoint/blob/main/LICENSE)\n\n## Author\n* Qi Zhao([zhaoqi99@outlook.com](mailto:zhaoqi99@outlook.com))\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A library that provides basic status and tasks endpoint for Django Celery Beat.",
    "version": "0.1.2",
    "project_urls": {
        "Changelog": "https://github.com/ZhaoQi99/django-celery-beat-endpoint/releases",
        "Homepage": "https://github.com/ZhaoQi99/django-celery-beat-endpoint",
        "Issue Tracker": "https://github.com/ZhaoQi99/django-celery-beat-endpoint/issues",
        "Source": "https://github.com/ZhaoQi99/django-celery-beat-endpoint"
    },
    "split_keywords": [
        "django",
        " celery",
        " beat",
        " status",
        " endpoint"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "58a20c5830c1e46fab71bc1a3344ffa4aece6d0e8d1049425f8a81a3d0c41984",
                "md5": "1f9ec4b154668dc6ad9dbec72c63cb7b",
                "sha256": "a8d62fe33c12208d6e2d92789cc4825d737e8058c6714ec55562507dd7233762"
            },
            "downloads": -1,
            "filename": "django_celery_beat_endpoint-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1f9ec4b154668dc6ad9dbec72c63cb7b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 18079,
            "upload_time": "2024-06-21T03:56:31",
            "upload_time_iso_8601": "2024-06-21T03:56:31.794898Z",
            "url": "https://files.pythonhosted.org/packages/58/a2/0c5830c1e46fab71bc1a3344ffa4aece6d0e8d1049425f8a81a3d0c41984/django_celery_beat_endpoint-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fe2cb7d5f5b9c0202f693ebea6701b18622741b0c8dcd724290f80f0e61ce1bc",
                "md5": "b420cd1c0815ea530740edcd4fd404e3",
                "sha256": "e9804465fe18f7a1c542d4a3f1a489849fa959bc4c9a34d75ce723989ff7c9d4"
            },
            "downloads": -1,
            "filename": "django_celery_beat_endpoint-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "b420cd1c0815ea530740edcd4fd404e3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 16873,
            "upload_time": "2024-06-21T03:56:33",
            "upload_time_iso_8601": "2024-06-21T03:56:33.209079Z",
            "url": "https://files.pythonhosted.org/packages/fe/2c/b7d5f5b9c0202f693ebea6701b18622741b0c8dcd724290f80f0e61ce1bc/django_celery_beat_endpoint-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-21 03:56:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ZhaoQi99",
    "github_project": "django-celery-beat-endpoint",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "django-celery-beat-endpoint"
}
Qi Zhao
Elapsed time: 0.24589s