Skip to main content
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)

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 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

Metadata

Release files for django-carrot 1.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-carrot 1.5.0
File Size Uploaded Provenance
django-carrot-1.5.0.tar.gz 203.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for django-carrot 1.5.0
File Interpreter ABI Platform
django_carrot-1.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 413.8 kB

Release files / django-carrot-1.5.0.tar.gz

Download URL django-carrot-1.5.0.tar.gz
Size 203.4 kB
Tags Source
SHA-256 checksum
How to use checksums
643611889459c00d137b9a3db504746857209fe61f41a70dabb8715350487a9f
BLAKE2b-256 checksum
How to use checksums
6f21ddee1aa4d94c49dbaca2310b6c5ddd4c39309da79cf10bf417e1edbf67a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/0.12.12 CPython/3.6.3 Linux/4.4.0-101-generic

Release files / django_carrot-1.5.0-py3-none-any.whl

Download URL django_carrot-1.5.0-py3-none-any.whl
Size 210.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b1fbe07471e1e3a53b2190a3082d4a7dc8201a1f3bc8a70ccc821968a5225528
BLAKE2b-256 checksum
How to use checksums
ebcc584b9bbc68932445869f7391feef9475bae7f0261e2c3c00fbd5c1cd4e83
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/0.12.12 CPython/3.6.3 Linux/4.4.0-101-generic

Security for django-carrot 1.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.5.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page