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

Metadata

Release files for django-carrot-dev 262

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-dev 262
File Size Uploaded Provenance
django-carrot-dev-262.tar.gz 198.9 kB Without provenance Details

Release files / django-carrot-dev-262.tar.gz

Download URL django-carrot-dev-262.tar.gz
Size 198.9 kB
Tags Source
SHA-256 checksum
How to use checksums
341e486452ece010fbcddec5b0bc798c65f997def90a8cbb57863a3fb743177a
BLAKE2b-256 checksum
How to use checksums
1b9ae02b09939f6850d93bc450209080dda49bedd768fe70c009dd609996f245
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for django-carrot-dev 262

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.

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