modelqueue 1.0.3

ModelQueue is an Apache2 licensed task queue based on Django models.

For example, in appname/models.py:

import modelqueue
from django.db import models

class Task(models.Model):
    data = models.TextField()
    status = modelqueue.StatusField(
        db_index=True,
        # ^-- Index for faster queries.
        default=modelqueue.Status.waiting,
        # ^-- Waiting state is ready to run.
    )

And in appname/management/commands/process_tasks.py:

import modelqueue, time
from django.core.management.base import BaseCommand
from .models import Task

class Command(BaseCommand):

    def handle(self, *args, **options):
        while True:
            task = modelqueue.run(
                Task.objects.all(),
                # ^-- Queryset of models to process.
                'status',
                # ^-- Field name for model queue.
                self.process,
                # ^-- Callable to process model.
            )
            if task is None:
                time.sleep(0.1)
                # ^-- Bring your own parallelism/concurrency.

    def process(self, report):
        pass  # Process task models.

And in appname/admin.py:

class TaskAdmin(admin.TaskAdmin):
    list_filter = [
        modelqueue.admin_list_filter('status'),
        # ^-- Filter tasks in admin by queue state.
    ]

ModelQueue is a hazardous project. It takes a bad idea and makes it easy and effective. You may come to regret using your database as a task queue but it won’t be today!

Features

• Pure-Python

• Fully documented

• Performance matters

• 100% test coverage

• Hours of stress testing

• Developed on Python 3.6

• Tested on Django 1.11

• Tested on CPython 2.7, 3.4, 3.5, 3.6, PyPy and PyPy3

• Tested on Linux, Mac OS X, and Windows

• Tested using Travis CI and AppVeyor CI

$ python -m pip install modelqueue

>>> import modelqueue
>>> help(modelqueue)