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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-task-api-1.2.1.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.5

File hashes

Hashes for django-task-api-1.2.1.tar.gz
Algorithm Hash digest
SHA256 dcfea9d2a53fb69567953b763a25b4b33c271f47c54e11bedad3993660969ffe
MD5 7695d86dcdaa85f98b7250ca553dc34d
BLAKE2b-256 5ee3d5d77d889aca080bb3d7c0c9cd911a23da397614ba1c32a808724d4d95a4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: django_task_api-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.5

File hashes

Hashes for django_task_api-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6149c399b9bbea4a71114c5a69a4d9bc615c9d053e868aedb197ae8a73c064eb
MD5 4308605ed6d97f1eda5a69f4fd52396d
BLAKE2b-256 158deb5b398de8d3b09a0f4a0340f1ad32f583cf0d79009625dfb080afa713e6

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