Skip to content

ipsosante/django-taskq

Repository files navigation

django-taskq

MIT Build Status Codecov

django-taskq is an asynchronous task queue/job queue for Django. It's a lightweight alternative to Celery.

Usage

Install django-taskq:

pip install django-taskq

Run the main worker with:

./manage.py taskqrunworker

Then open a Django shell and add tasks:

./manage.py shell
>>> from example.tasks import add
>>> add.apply_async(16, 2)

Contributing

Setup the development environment with

python -m venv $(pwd)/virtualenv
. ./virtualenv/bin/activate
pip install -r requirements_dev.txt

Setup the PostgreSQL database:

brew install postgresql@10
initdb /path/to/database/storage  # For example /usr/local/var/postgres

# Start PostgreSQL on port 5432
pg_ctl -D /path/to/database/storage -o "-p 5432" start

# Create a postgres user allowed to create our test database
psql -p 5432 -d postgres -c "CREATE USER postgres WITH PASSWORD 'IN0vRycvrF' CREATEDB"

Set your PYTHONPATH to the developement directory:

export PYTHONPATH=$PYTHONPATH:$PWD

Run the test suite with

pytest

To collect coverage data run the test suite with

pytest --cov=taskq tests/

To collect coverage data as HTML and view it in your browser, use

pytest --cov-report html --cov=taskq tests/; open htmlcov/index.html

If you want to run django-admin commands, you'll need to set DJANGO_SETTINGS_MODULE to a valid settings module, e.g.:

export DJANGO_SETTINGS_MODULE=tests.settings

To create a new release of django-taskq, use bumpversion. e.g.:

bumpversion minor

This will update all the necessary files and commit + tag the changes.

License

django-taskq is released under the MIT license. See LICENSE for details.