Skip to main content

A RabbitMQ asynchronous task queue for Django.

Project description

https://coveralls.io/repos/github/chris104957/django-carrot/badge.svg?branch=master https://readthedocs.org/projects/django-carrot/badge/?version=latest https://travis-ci.org/chris104957/django-carrot.svg?branch=master https://coveralls.io/repos/github/chris104957/django-carrot/badge.svg?branch=master https://badge.fury.io/py/django-carrot.svg https://img.shields.io/badge/License-Apache%202.0-blue.svg /docs/source/images/carrot-logo-big.png

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',
    ...
]
  1. 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 at www.django-carrot.com

Support

If you are having any issues, please log an issue

Contributing

Django-carrot uses PyPRI to share development builds. If you’d like access to it, please send me your email address at christopherdavies553@gmail.com 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-carrot-1.3.3.tar.gz (199.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page