gaybro8777 / django-carrot

A lightweight task queue for Django using RabbitMQ

django-carrot is a lightweight task queue backend for Django projects that uses the RabbitMQ message broker, with an emphasis on quick and easy configuration and task tracking

Installation

Install django-carrot:

pip install django-carrot

Install and run RabbitMQ

brew install rabbitmq
brew services start rabbitmq

Configuration

1. Add carrot to your Django project's settings module:

INSTALLED_APPS = [
    ...
    'carrot',
    ...
]

2. Apply the carrot migrations to your project's database:

python manage.py migrate carrot

Usage

To start the service:

python manage.py carrot_daemon start

To run tasks asynchronously:

from carrot.utilities import publish_message

def my_task(**kwargs):
    return 'hello world'

publish_message(my_task, hello=True)

To schedule tasks to run at a given interval

from carrot.utilities import create_scheduled_task

create_scheduled_task(my_task, {'seconds': 5}, hello=True)

Note

The above commands must be made from within the Django environment

Docker

A sample docker config is available here

Full documentation

The full documentation is available here

Support

If you are having any issues, please log an issue

Contributing

Django-carrot uses Packagr to share development builds. If you'd like access to it, please send me your email address at [e-mail] so I can give you access

License

The project is licensed under the Apache license.

Icons made by Trinh Ho from www.flaticon.com is licensed by CC 3.0 BY