app-generator/sample-django-celery

Django & Celery Integration - Open-Source Sample | AppSeed.us

Django Tasks Manager via Celery

Open-source Django Dashboard generated by AppSeed op top of a modern design. Designed for those who like bold elements and beautiful websites, Soft UI Dashboard is ready to help you create stunning websites and webapps. Soft UI Dashboard is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.

• 👉 Soft UI Dashboard Django - product page
• 👉 Complete documentation - Learn how to use and update the product

Built with App Generator, timestamp 2022-10-03 15:29

• ✅ Up-to-date dependencies
• ✅ Bootstrap 5 Design, Dark Mode (persistent)
• ✅ Async TASKS via Celery
  • Tasks on-demand creation
  • Scrips Execution via Celery
  • Tasks Canceling
  • LOGS view option in the UI

✨ Video Presentation

Django-And-Celery-Tasks-Manager.mp4

✨ How to use it

Download the code

$ # Get the code
$ git clone https://github.com/app-generator/sample-django-celery.git
$ cd sample-django-celery

✨ Start the app in Docker

Step 1 - Download the code from the GH repository (using GIT)

$ # Get the code
$ git clone https://github.com/app-generator/sample-django-celery.git
$ cd sample-django-celery

Step 2 - Start the APP in Docker

$ docker-compose up --build 

Visit http://localhost:5085 in your browser. The app should be up & running.

👉 Set Up for Unix, MacOS

Install modules via VENV

$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt

Set Up Database

$ python manage.py makemigrations
$ python manage.py migrate

Start the app

$ python manage.py runserver

At this point, the app runs at http://127.0.0.1:8000/.

Start Celery (another terminal)

Note: Redis server is expected on port 6379 (default)

$ celery --app=core.celery.app worker --loglevel=info 

👉 Set Up for Windows

Install modules via VENV (windows)

$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt

Set Up Database

$ python manage.py makemigrations
$ python manage.py migrate

Start the app

$ python manage.py runserver

At this point, the app runs at http://127.0.0.1:8000/.

✨ Create Users

By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:

• Start the app via python manage.py runserver
• Access the registration page and create a new user:
  • http://127.0.0.1:8000/register/
• Access the sign in page and authenticate
  • http://127.0.0.1:8000/login/

✨ Code-base structure

The project is coded using a simple and intuitive structure presented below:

< PROJECT ROOT >
   |
   |-- core/                               # Implements app configuration
   |    |-- settings.py                    # Defines Global Settings
   |    |-- wsgi.py                        # Start the app in production
   |    |-- urls.py                        # Define URLs served by all apps/nodes
   |
   |-- apps/
   |    |
   |    |-- tasks/                         # Implements Celery LOGIC
   |    |    |-- views.py                  # Loads INDEX page for tasks
   |    |    |-- urls.py                   # Define Celery routes  
   |    |
   |    |-- home/                          # A simple app that serve HTML files
   |    |    |-- views.py                  # Serve HTML pages for authenticated users
   |    |    |-- urls.py                   # Define some super simple routes  
   |    |
   |    |-- authentication/                # Handles auth routes (login and register)
   |    |    |-- urls.py                   # Define authentication routes  
   |    |    |-- views.py                  # Handles login and registration  
   |    |    |-- forms.py                  # Define auth forms (login and register) 
   |    |
   |    |-- static/
   |    |    |-- <css, JS, images>         # CSS files, Javascripts files
   |    |
   |    |-- templates/                     # Templates used to render pages
   |         |-- includes/                 # HTML chunks and components
   |         |    |-- navigation.html      # Top menu component
   |         |    |-- sidebar.html         # Sidebar component
   |         |    |-- footer.html          # App Footer
   |         |    |-- scripts.html         # Scripts common to all pages
   |         |
   |         |-- layouts/                   # Master pages
   |         |    |-- base-fullscreen.html  # Used by Authentication pages
   |         |    |-- base.html             # Used by common pages
   |         |
   |         |-- accounts/                  # Authentication pages
   |         |    |-- login.html            # Login page
   |         |    |-- register.html         # Register page
   |         |
   |         |-- home/                      # UI Kit Pages
   |              |-- index.html            # Index page
   |              |-- 404-page.html         # 404 page
   |              |-- *.html                # All other pages
   |
   |-- requirements.txt                     # Development modules - SQLite storage
   |
   |-- .env                                 # Inject Configuration via Environment
   |-- manage.py                            # Start the app - Django default start script
   |
   |-- ************************************************************************

---

Django Tasks Manager via Celery - Open-source starter provided by AppSeed Generator.

sample-django-celery's Issues

Celery / Django - How to use the feature

Hello @cyber237

Please document at minimum how to use the feature.
I just added a new section on the README:

https://github.com/app-generator/sample-django-celery/blob/master/README.md#celerydjango-quick-start

Ty!

ENH - Django Celery Integration + UI (tasks manager)

The existing Django codebase should be enhanced with Celery Integration plus a page where tasks can be managed and view the execution stats.

Current Project:
https://github.com/app-generator/django-soft-ui-dashboard

Here are the requirements:

Tables:

• tasks: id (PK), name, script_name, description
• tasks_status: id (PK), task_id, ts_start, ts_end, status, log_file

What the developer should deliver:

Feature 1 - Use the existing UI and code pages:

• task creation/update page (factorized using a single page)
• tasks index page, where all tasks are listed using a paginated data table

Feature 2 - Interactions

• users are able to create tasks
• if a task is running, in the UI, the user is able to kill the status

Delivery time ~= 5days.

ENH - List the results in Index page

Hello @cyber237

The new component should list the items saved in the table:

django_celery_results_task_result

Another improvement is to correlate each item with the LOG saved in the celery_logs folder.
At this moment we have the logs, but is impossible to link the LOG with an item of django_celery_results_task_result

Ty!

ENH - The Task that executes the scripts INPUT

Hello @cyber237

The UI is updated to list all available tasks. When the superuser restarts the task, the selected SCRIPT should be executed.

Please code this evolution.
Ty!

ValueError at /tasks/cancel

Hi whenever I click on cancel this error comes up :

ValueError at /tasks/cancel/aff1a8a6-56d4-4c0a-be72-5a6367597787
Exception information must includethe exception type

DOCS - Django / Celery Integration

Hello @cyber237

In order to help beginners digest easily the concept, please update all sections in this document:

https://github.com/app-generator/sample-django-celery/blob/master/docs/how-to-integrate-celery.md

Note: Please add the bare minimum information in each paragraph and also, feel free to add something that you think that might be useful.

Ty!