{"id":20481144,"url":"https://github.com/chris104957/django-carrot","last_synced_at":"2025-08-20T12:32:09.372Z","repository":{"id":39674203,"uuid":"106683254","full_name":"chris104957/django-carrot","owner":"chris104957","description":"A lightweight task queue for Django using RabbitMQ","archived":false,"fork":false,"pushed_at":"2022-12-08T05:39:51.000Z","size":2051,"stargazers_count":71,"open_issues_count":10,"forks_count":15,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-05-22T18:23:06.060Z","etag":null,"topics":["asynchronous-tasks","django","django-carrot","pika","python3","rabbitmq","task-queue"],"latest_commit_sha":null,"homepage":"https://django-carrot.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chris104957.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-12T11:21:09.000Z","updated_at":"2023-12-12T16:37:11.000Z","dependencies_parsed_at":"2023-01-24T14:31:03.212Z","dependency_job_id":null,"html_url":"https://github.com/chris104957/django-carrot","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris104957%2Fdjango-carrot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris104957%2Fdjango-carrot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris104957%2Fdjango-carrot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris104957%2Fdjango-carrot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chris104957","download_url":"https://codeload.github.com/chris104957/django-carrot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229848542,"owners_count":18133649,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asynchronous-tasks","django","django-carrot","pika","python3","rabbitmq","task-queue"],"created_at":"2024-11-15T16:06:56.922Z","updated_at":"2024-12-19T11:13:01.539Z","avatar_url":"https://github.com/chris104957.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: https://coveralls.io/repos/github/chris104957/django-carrot/badge.svg?branch=master\n    :target: https://coveralls.io/github/chris104957/django-carrot?branch=master\n\n.. image:: https://readthedocs.org/projects/django-carrot/badge/?version=latest\n    :target: http://django-carrot.readthedocs.io/en/latest/?badge=\n\n.. image:: https://travis-ci.org/chris104957/django-carrot.svg?branch=master\n    :target: https://travis-ci.org/chris104957/django-carrot.svg?branch=master\n\n.. image:: https://coveralls.io/repos/github/chris104957/django-carrot/badge.svg?branch=master\n    :target: https://coveralls.io/github/chris104957/django-carrot?branch=master)\n\n.. image:: https://badge.fury.io/py/django-carrot.svg\n    :target: https://badge.fury.io/py/django-carrot\n\n.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg\n    :target: https://opensource.org/licenses/Apache-2.0\n\n.. image:: /docs/source/images/carrot-logo-big.png\n    :align: center\n\n**django-carrot** is a lightweight task queue backend for Django projects that uses the RabbitMQ message broker, with\nan emphasis on quick and easy configuration and task tracking\n\nInstallation\n------------\n\nInstall django-carrot:\n\n.. code-block:: bash\n\n    pip install django-carrot\n\nInstall and run RabbitMQ\n\n.. code-block:: bash\n\n    brew install rabbitmq\n    brew services start rabbitmq\n\nConfiguration\n-------------\n\n1. Add carrot to your Django project's settings module:\n\n.. code-block:: python\n\n    INSTALLED_APPS = [\n        ...\n        'carrot',\n        ...\n    ]\n\n\n2. Apply the carrot migrations to your project's database:\n\n.. code-block:: python\n\n    python manage.py migrate carrot\n\n\nUsage\n-----\n\nTo start the service:\n\n.. code-block:: bash\n\n    python manage.py carrot_daemon start\n\n\nTo run tasks asynchronously:\n\n.. code-block:: python\n\n    from carrot.utilities import publish_message\n\n    def my_task(**kwargs):\n        return 'hello world'\n\n    publish_message(my_task, hello=True)\n\n\n\nTo schedule tasks to run at a given interval\n\n.. code-block:: python\n\n    from carrot.utilities import create_scheduled_task\n\n    create_scheduled_task(my_task, {'seconds': 5}, hello=True)\n\n\n.. note::\n    The above commands must be made from within the Django environment\n\nDocker\n------\n\nA sample docker config is available `here \u003chttps://github.com/chris104957/django-carrot-docker\u003e`_\n\nFull documentation\n------------------\n\nThe full documentation is available `here \u003chttps://django-carrot.readthedocs.io/\u003e`_\n\nSupport\n-------\n\nIf you are having any issues, please `log an issue \u003chttps://github.com/chris104957/django-carrot/issues/new\u003e`_\n\nContributing\n------------\n\nDjango-carrot uses `Packagr \u003chttps://www.packagr.app/\u003e`_ to share development builds. If you'd like access to it,\nplease send me your email address at christopherdavies553@gmail.com so I can give you access\n\nLicense\n-------\n\nThe project is licensed under the Apache license.\n\nIcons made by Trinh Ho from `www.flaticon.com \u003cwww.flaticon.com\u003e`_ is licensed by CC 3.0 BY\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris104957%2Fdjango-carrot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchris104957%2Fdjango-carrot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris104957%2Fdjango-carrot/lists"}