https://github.com/ericls/django-simple-task

Simple background task for Django 3
https://github.com/ericls/django-simple-task

asgi django hacktoberfest python task-runner

Last synced: 3 months ago
JSON representation

Simple background task for Django 3

• Host: GitHub
• URL: https://github.com/ericls/django-simple-task
• Owner: ericls
• License: mit
• Created: 2019-12-29T04:17:03.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T07:42:04.000Z (about 2 years ago)
• Last Synced: 2024-10-12T07:25:46.051Z (3 months ago)
• Topics: asgi, django, hacktoberfest, python, task-runner
• Language: Python
• Homepage: https://django-simple-task.rtfd.org
• Size: 111 KB
• Stars: 87
• Watchers: 3
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Django Simple Task

[![Github Actions](https://github.com/ericls/django-simple-task/workflows/Build/badge.svg)](https://github.com/ericls/django-simple-task/actions)

[![Documentation Status](https://readthedocs.org/projects/django-simple-task/badge/?version=latest)](https://django-simple-task.readthedocs.io/?badge=latest)

[![Code Coverage](https://codecov.io/gh/ericls/django-simple-task/branch/master/graph/badge.svg)](https://codecov.io/gh/ericls/django-simple-task)

[![Python Version](https://img.shields.io/badge/Python-3.7%20|%203.8|%203.9-%231081c1)](https://pypi.org/project/django-simple-task/)

[![PyPI Package](https://img.shields.io/pypi/v/django-simple-task.svg)](https://pypi.org/project/django-simple-task/)

[![License](https://img.shields.io/pypi/l/django-simple-task.svg)](https://github.com/ericls/django-simple-task/blob/master/LICENSE)

`django-simple-task` runs background tasks in Django 3 without requiring other services and workers. It runs them in the same event loop as your ASGI application. It is not resilient as a proper task runner such as Celery, but works for some simple tasks and has less overall overheads.

## Requirements

`django-simple-task` expect ASGI lifespan protocol to be supported by the server. Currently Daphne does not support this.

This package is tested with:

 - Python 3.7, 3.8 and 3.9,

 - Django 3.1 and 3.2.

## Guide

Install the package:

```bash

pip install django-simple-task

```

Added it to installed apps:

```python

# settings.py

INSTALLED_APPS = [

	...

	'django_simple_task'

]

```

Apply ASGI middleware :

```python

# asgi.py

from django_simple_task import django_simple_task_middlware

application = django_simple_task_middlware(application)

```

Call a background task in Django view:

```python

from django_simple_task import defer

def task1():

	time.sleep(1)

	print("task1 done")

async def task2():

	await asyncio.sleep(1)

	print("task2 done")

def view(requests):

	defer(task1)

	defer(task2)

	return HttpResponse(b"My View")

```

It is required to run Django with ASGI server. [Official Doc](https://docs.djangoproject.com/en/3.0/howto/deployment/asgi/)

## Configurations

Concurrency level can be controlled by adding `DJANGO_SIMPLE_TASK_WORKERS` to settings. Defaults to `1`.