dj-tasks 2.0.0

A django app to run a collection of tasks in a management command.

A django app to run a collection of tasks in a management command.

Documentation

The full documentation is at https://dj-tasks.readthedocs.io.

Quickstart

Install dj-tasks:

pip install dj-tasks

Add it to your INSTALLED_APPS:

# project/settings.py
INSTALLED_APPS = [
    ...
    'dj_tasks',
    ...
]

Create a task:

# your_app/tasks.py
from dj_tasks.tasks import Task


class YourTask(Task):

    name = "Your Task"
    frequency = 60

    def run(self):
        print("Your custom code...")

Add to your DJTASKS_TASKS settings:

# project/settings.py
DJTASKS_LOCK_ID = "your_django_project"
DJTASKS_TASKS = [
    "your_app.tasks.YourTask",
]

Running Tests

Does the code actually work?

$ make install-dev
$ make lint
$ make test

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-djangopackage

History

2.0.0 (2022-09-25)

• handle exception when running individual tasks

• Drop support for django <3.2

• Add support for django 4.0 and 4.1

1.1.0 (2020-12-28)

• add documentation of DJTASKS_LOCK_ID to Quickstart

• update MakeFile to use current work flow

• close database connection after each full run

• add dj_tasks.tasks.DeleteOldTaskRunTask

• flake8 fixes

• add twine for easier releases

• move to GitHub Actions from Travis CI

• drop testing with tox

1.0.0 (2020-07-01)

• require setting DJTASKS_LOCK_ID

0.1.0 (2020-06-05)

• First release on PyPI.