Skip to main content

A REST API for managing background tasks in Django

Project description

Django Task API lets you quickly write background tasks for your Django project and easily call then using the provided REST API, or the included JavaScript library.

What does it look like?

Tasks are defined as classes with typed input and output parameters, and a run function with the task implementation, to be called by a worker processes.

from task_api.tasks import Task
from task_api.params import ListParameter, NumberParameter

class SumNumbers(Task):
    name = 'sum'

    inputs = {
        'numbers': ListParameter(NumberParameter())
    }

    outputs = {
        'sum': NumberParameter()
    }

    def run(self, numbers):
        return sum(numbers)

Tasks are easily called and monitored in front-end code using the included JavaScript API. The API supports both promises (will Polyfill for older browsers) and traditional callbacks.

<script src="{% static 'django-task-api.min.js' %}"></script>

<script type="text/javascript">
    function sumTask(numbers) {
        TaskAPI
            .run('sum', {'numbers': numbers})
            .then(function(json) {
                console.log('Sum: ' + json.outputs.sum)
            })
    }
</script>

Next Steps

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-task-api-1.2.5.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

django_task_api-1.2.5-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file django-task-api-1.2.5.tar.gz.

File metadata

  • Download URL: django-task-api-1.2.5.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for django-task-api-1.2.5.tar.gz
Algorithm Hash digest
SHA256 f206a42225c8e70604c4567eb5a523a1d8a5124e9f9e2956dc671cf809fdb93b
MD5 49e448bd33f7cb942080cfc4dd7c98c9
BLAKE2b-256 5a3e1b7434a6757f0991366f715633b4dd7452fa552c0b6a21eaa5660e509648

See more details on using hashes here.

File details

Details for the file django_task_api-1.2.5-py3-none-any.whl.

File metadata

  • Download URL: django_task_api-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for django_task_api-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5f6ccfec024129949e01e55cf951bb3666f404e710766253e1794e00eb088f25
MD5 00dee6510861884cf36391684b61503f
BLAKE2b-256 d997f9251a3a47a93d38989a510d9883a0e390e42bb2607126b35b34752219ec

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page