https://github.com/django-background-tasks/django-background-tasks

A database-backed work queue for Django
https://github.com/django-background-tasks/django-background-tasks

background-jobs background-sync background-thread django python queue queueing

Last synced: 29 days ago
JSON representation

A database-backed work queue for Django

• Host: GitHub
• URL: https://github.com/django-background-tasks/django-background-tasks
• Owner: django-background-tasks
• License: bsd-3-clause
• Fork: true (lilspikey/django-background-task)
• Created: 2015-04-30T11:50:42.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T15:46:22.000Z (6 months ago)
• Last Synced: 2025-01-08T22:02:58.404Z (about 1 month ago)
• Topics: background-jobs, background-sync, background-thread, django, python, queue, queueing
• Language: Python
• Homepage:
• Size: 303 KB
• Stars: 621
• Watchers: 24
• Forks: 147
• Open Issues: 92
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• best-django-resource - django-background-tasks - Run background tasks with Django. (Job Queue & Background Tasks)

README

        
=======================

Django Background Tasks

=======================

.. image:: https://travis-ci.org/arteria/django-background-tasks.svg?branch=master

    :target: https://travis-ci.org/arteria/django-background-tasks

    :alt: Build Status

.. image:: https://coveralls.io/repos/arteria/django-background-tasks/badge.svg?branch=master

    :target: https://coveralls.io/repos/arteria/django-background-tasks/badge.svg?branch=master&service=github

    :alt: Coverage Status

.. image:: https://readthedocs.org/projects/django-background-tasks/badge/?version=latest

    :target: http://django-background-tasks.readthedocs.io/en/latest/?badge=latest

    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/django-background-tasks.svg

    :target: https://pypi.python.org/pypi/django-background-tasks

    :alt: PyPI

Django Background Task is a database-backed work queue for Django, loosely based around `Ruby's DelayedJob`_ library. This project was adopted and adapted from lilspikey_ `django-background-task`.

.. _Ruby's DelayedJob: https://github.com/tobi/delayed_job

.. _lilspikey: https://github.com/lilspikey/

To avoid conflicts on PyPI we renamed it to django-background-tasks (plural). For an easy upgrade from django-background-task to django-background-tasks, the internal module structure were left untouched.

In Django Background Task, all tasks are implemented as functions (or any other callable).

There are two parts to using background tasks:

- creating the task functions and registering them with the scheduler

- setup a cron task (or long running process) to execute the tasks

Docs

====

See `Read the docs`_.

.. _Read the docs: http://django-background-tasks.readthedocs.io/en/latest/