https://github.com/haoke98/django-celery-stack
A merge of django-celery-beat, django-celery-result, django-celery-progress.
https://github.com/haoke98/django-celery-stack
celery django django-celery django-celery-beat django-celery-progress django-celery-result task-distribution task-scheduler
Last synced: about 1 month ago
JSON representation
A merge of django-celery-beat, django-celery-result, django-celery-progress.
- Host: GitHub
- URL: https://github.com/haoke98/django-celery-stack
- Owner: Haoke98
- License: other
- Created: 2024-03-19T14:26:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-31T13:55:25.000Z (over 1 year ago)
- Last Synced: 2025-03-18T17:31:49.889Z (8 months ago)
- Topics: celery, django, django-celery, django-celery-beat, django-celery-progress, django-celery-result, task-distribution, task-scheduler
- Language: Python
- Homepage:
- Size: 332 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Celery Stack
English | [中文](README.zh.md)
A comprehensive stack solution that ensures seamless compatibility between Celery and Django, integrating key components
such as django-celery-beat, django-celery-result, and django-celery-progress. This integration provides web developers
with a robust framework for handling asynchronous tasks, scheduling, and tracking task execution within their Django
projects.
In addition, its interface and interaction are very friendly and modern, and it has overcome the traditional interaction
shortcomings of Django by referencing [DjangoAsyncAdmin](https://github.com/Haoke98/DjangoAsyncAdmin).
### Django Celery Stack & Admin offers the following key features:
* **Asynchronous Task Queue** :
Utilize Celery’s distributed message passing system to delegate CPU-bound tasks to the background, improving the responsiveness and performance of the application.
* Scheduled Task Scheduler:
With the built-in Celery Beat scheduler, easily arrange periodic tasks such as data synchronization, report generation, etc.
* Task Result Tracking:
Leverage Celery’s result backend to persist task execution results, making it easier to debug and monitor task status.
* Progress Updates:
By integrating with django-celery-progress, provide real-time task progress updates to users for interactive feedback.
* Optimized Management Interface:
Building on the foundation of the three projects, DjangoAsyncAdmin is used to optimize and enhance the interaction and management pages, making it more intuitive and convenient to manage tasks and monitor progress.
* Easy to Integrate and Extend:
The design of Django Celery Stack & Admin is flexible, allowing for easy integration with other Django applications and Celery components to meet various requirements.
For both traditional web developers handling substantial data processing needs and system administrators tasked with
intricate scheduling, this full stack solution for Celery and Django compatibility is the optimal selection.
It delivers a proficient and scalable framework for managing asynchronous tasks and scheduling, enhancing the
performance of your Django projects. Embrace this solution today and begin reaping the benefits of streamlined task
management and scheduling within your Django environment.
### Usage
1. Install
```shell
pip install django-celery-stack
```
2. Django project configuration
* Register APP (settings.py)
```python
# Application definition
INSTALLED_APPS = [
...
django_celery_stack
...
]
```
* configure the result backend ( `settings.py` )
```python
CELERY_RESULT_BACKEND = "django_celery_stack.backends:CustomDatabaseBackend"
```
* configure the url and router ( `proj.urls.py` ):
```python
urlpatterns.append(path('celery/', include('django_celery_stack.urls')))
```
* create a `celery.py` file under the `proj` folder:
```python
import os
from celery import Celery
from celery.schedules import crontab
# Set the default Django settings module for the 'celery' program.
os.environ.setdefault('DJANGO_SETTINGS_MODULE', '.settings')
app = Celery('')
# Using a string here means the worker doesn't have to serialize
# the configuration object to child processes.
# - namespace='CELERY' means all celery-related configuration keys
# should have a `CELERY_` prefix.
app.config_from_object('django.conf:settings', namespace='CELERY')
app.conf.update(
task_time_limit=3600, # 将任务超时时间设置为 3600 秒（1小时）
)
# Load task modules from all registered Django apps.
app.autodiscover_tasks(packages=[''])
```
* load the `celery.py` to the running. ( `proj.__init__.py` ):
```python
from .celery import app as celery_app
__all__ = ('celery_app',)
```
### Develop Plan
* [ ] Implement an automatic task distribution mechanism to make task distribution more flexible and convenient.
* [ ] Re-adjust the result management of subtasks and parent tasks.
* [ ] Persistence and associated display of associated information between main and subtasks.
* [ ] Refer to [celery-progress](https://github.com/czue/celery-progress)
* [ ] Refer to [django-celery-monitor](https://github.com/jazzband/django-celery-monitor)
### Develop & Contribution
1. Clone the project to your local.
```shell
git clone https://github.com/Haoke98/django-celery-stack.git
```
2. Build the package.
```shell
python setup.py build sdist
```
3. Deploy to [PyPI](https://pypi.org).
```shell
twine upload dist/*
```