Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/django-tasks-manager
Django Tasks Manager - Simple Celery Integration | AppSeed
https://github.com/app-generator/django-tasks-manager
celery django dynamic-programming open-source pypi-package
Last synced: 17 days ago
JSON representation
Django Tasks Manager - Simple Celery Integration | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/django-tasks-manager
- Owner: app-generator
- License: mit
- Created: 2022-10-12T13:46:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-01T04:01:24.000Z (about 2 years ago)
- Last Synced: 2024-10-11T04:43:30.398Z (about 1 month ago)
- Topics: celery, django, dynamic-programming, open-source, pypi-package
- Language: Python
- Homepage: https://appseed.us/developer-tools/django-tasks-manager/
- Size: 80.1 KB
- Stars: 12
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Django Tasks Manager](https://appseed.us/developer-tools/django-tasks-manager/)
A super simple **Django & Celery** integration - This library is actively supported by [AppSeed](https://appseed.us/).
> Features:
- Create/Revoke `Celery Tasks`
- `View LOGS` & Output
- `Minimal Configuration`
- Available [TASKS](https://github.com/app-generator/django-tasks-manager/blob/main/django_tm/tasks.py) (provided as starting samples)
- `users_in_db()` - List all registered users
- `execute_script()` - let users execute the [scripts](https://github.com/app-generator/django-tasks-manager/tree/main/django_tm/celery_scripts) defined in `CELERY_SCRIPTS_DIR` (CFG parameter)
- [check-db-health.py](https://github.com/app-generator/django-tasks-manager/blob/main/django_tm/celery_scripts/check-db-health.py) (sample)
## How to use it
> **Install the package** via `PIP`
```bash
$ pip install django-tasks-manager
// OR
$ pip install git+https://github.com/app-generator/django-tasks-manager.git
```
> **Include the new routing**
```python
# core/urls.py
from django.urls import path, include # <-- UPDATE: Add 'include' HELPER
urlpatterns = [
...
path("", include("django_tm.urls")), # <-- New Routes
...
]
```
> Create **Scrips & LOGS** directories - The Recomended place is in the root of the project:
```bash
$ mkdir celery_scripts # Used in Settings -> CELERY_SCRIPTS_DIR
$ mkdir celery_logs # Used in Settings -> CELERY_SCRIPTS_DIR
```
- Make sure the user that executes the app has write permission.
- Copy the [sample scripts](./django_tm/celery_scripts) in the scripts directory.
- All scripts will be available in the UI, ready to be executed by the manager.
> **Update Configuration** Add `os` object import
```python
import os # <-- NEW
```
> **Update Configuration**: Include the new APPS
```python
INSTALLED_APPS = [
...
'django_tm', # Django Tasks Manager # <-- NEW
'django_celery_results', # Django Celery Results # <-- NEW
]
```
> **Update Configuration**: Include the new templates
```python
TEMPLATE_DIR_TASKS = os.path.join(BASE_DIR, "django_tm/templates") # <-- NEW
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [TEMPLATE_DIR_TASKS], # <-- Updated
'APP_DIRS': True,
},
]
```
> **Update Configuration**: New **CELERY_** Section
```python
#############################################################
# Celery configurations
# https://docs.celeryq.dev/en/stable/django/first-steps-with-django.html
# !!!
# BASE_DIR points to the ROOT of the project
# Note: make sure you have 'os' object imported
# !!!
# !!!
# BASE_DIR = os.path.dirname(os.path.dirname(__file__))
# !!!
# Working Directories required write permission
CELERY_SCRIPTS_DIR = os.path.join(BASE_DIR, "celery_scripts" )
CELERY_LOGS_DIR = os.path.join(BASE_DIR, "celery_logs" )
CELERY_BROKER_URL = os.environ.get("CELERY_BROKER", "redis://localhost:6379")
CELERY_RESULT_BACKEND = os.environ.get("CELERY_BROKER", "redis://localhost:6379")
CELERY_TASK_TRACK_STARTED = True
CELERY_TASK_TIME_LIMIT = 30 * 60
CELERY_CACHE_BACKEND = "django-cache"
CELERY_RESULT_BACKEND = "django-db"
CELERY_RESULT_EXTENDED = True
CELERY_RESULT_EXPIRES = 60*60*24*30 # Results expire after 1 month
CELERY_ACCEPT_CONTENT = ["json"]
CELERY_TASK_SERIALIZER = 'json'
CELERY_RESULT_SERIALIZER = 'json'
#############################################################
#############################################################
```
> **Start the App**
```bash
$ # Set up the database
$ python manage.py makemigrations
$ python manage.py migrate
$
$ # Create the superuser
$ python manage.py createsuperuser
$
$ # Start the application (development mode)
$ python manage.py runserver # default port 8000
```
- **Authenticate** as `superuser`
- Access the `Tasks` page: `http://127.0.0.1:8000/tasks`
> **Start the Celery Manager** (another terminal) & **Update Environment**
Export `DJANGO_SETTINGS_MODULE` using the value provided in `manage.py`
```bash
$ export DJANGO_SETTINGS_MODULE=cfg.settings
```
The value used export should be taken from `manage.py`:
```python
def main():
"""Run administrative tasks."""
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "cfg.settings") # <-- VALUE to be exported
try:
from django.core.management import execute_from_command_line
except ImportError as exc:
...
```
**Note**: `Redis` server is expected on port `6379` (default). In case Redis runs on other `PORT`, please update the configuration: `CELERY_BROKER_URL` and `CELERY_RESULT_BACKEND`.
```bash
$ celery --app=django_tm.celery.app worker --loglevel=info
```
## Screens
> `View all tasks`
> `View Task LOG`
## Links & Resources
- Free [Support](https://appseed.us/support/) via Email and Discord
- [Django Tasks Manager](https://github.com/app-generator/sample-django-tasks-manager) - `free sample` that explains:
- `Project Creation` (minimal files added)
- `Install` & Generate `Django` Core
- Install `Django-TM` (this package)
- `Update Configuration`
- `Start the app`
- Use the `Tasks Manager`
---
[Django Tasks Manager](https://appseed.us/developer-tools/django-tasks-manager/) - Open-source library provided by **[AppSeed](https://appseed.us/)**