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.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.1.1.tar.gz (72.8 kB view details)

Uploaded Source

Built Distribution

django_task_api-1.1.1-py3-none-any.whl (75.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-task-api-1.1.1.tar.gz
  • Upload date:
  • Size: 72.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

File hashes

Hashes for django-task-api-1.1.1.tar.gz
Algorithm Hash digest
SHA256 b8ac0dce5db279865fc9a2e32698ff199ceb47a77d2b077fe42edac98341b392
MD5 c8f502dbde03e6f80999bf7bdb524d01
BLAKE2b-256 3f05fba879e1410def4f6ba76c849c392b3a5c3911f3c300e003b1986c2729bd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: django_task_api-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 75.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

File hashes

Hashes for django_task_api-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c460e75cedbfef90acf169eb85f5f1f495112f13dab06cceb262dc652360bc4
MD5 8f37dc21cace3ef59f6f0d11cbb40b1f
BLAKE2b-256 9b49c35371f3aa11ade5eaad848e7993950daeccbc6f84265369459daf5f93b9

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