{"id":13625112,"url":"https://github.com/django-q2/django-q2","last_synced_at":"2025-04-16T06:31:45.565Z","repository":{"id":62604272,"uuid":"532383254","full_name":"django-q2/django-q2","owner":"django-q2","description":"A multiprocessing distributed task queue for Django based on Django-Q","archived":false,"fork":true,"pushed_at":"2024-11-03T14:32:24.000Z","size":2569,"stargazers_count":378,"open_issues_count":58,"forks_count":38,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-03T15:17:46.188Z","etag":null,"topics":["django","task-queue"],"latest_commit_sha":null,"homepage":"https://django-q2.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"Koed00/django-q","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/django-q2.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-09-03T22:01:52.000Z","updated_at":"2024-11-03T14:26:36.000Z","dependencies_parsed_at":"2023-09-26T17:22:27.376Z","dependency_job_id":"2b664ae0-5b06-4fea-bff3-91de35928623","html_url":"https://github.com/django-q2/django-q2","commit_stats":null,"previous_names":["gday/django-q2"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-q2%2Fdjango-q2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-q2%2Fdjango-q2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-q2%2Fdjango-q2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-q2%2Fdjango-q2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/django-q2","download_url":"https://codeload.github.com/django-q2/django-q2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223700242,"owners_count":17188277,"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":["django","task-queue"],"created_at":"2024-08-01T21:01:51.021Z","updated_at":"2025-04-16T06:31:45.549Z","avatar_url":"https://github.com/django-q2.png","language":"Python","funding_links":[],"categories":["Python","Third-Party Packages","Task Queue"],"sub_categories":["Task Queues"],"readme":"A multiprocessing distributed task queue for Django\n---------------------------------------------------\n\n|image0| |image1| |downloads|\n\nDjango Q2 is a fork of Django Q. Big thanks to Ilan Steemers for starting this project. Unfortunately, development has stalled since June 2021. Django Q2 is the new updated version of Django Q, with dependencies updates, docs updates and several bug fixes. Original repository: https://github.com/Koed00/django-q\n\nFeatures\n~~~~~~~~\n\n-  Multiprocessing worker pool\n-  Asynchronous tasks\n-  Scheduled, cron and repeated tasks\n-  Signed and compressed packages\n-  Failure and success database or cache\n-  Result hooks, groups and chains\n-  Django Admin integration\n-  PaaS compatible with multiple instances\n-  Multi cluster monitor\n-  Redis, IronMQ, SQS, MongoDB or ORM\n-  Rollbar and Sentry support\n\nChanges compared to the original Django-Q:\n\n- Dropped support for Disque (hasn't been updated in a long time)\n- Dropped Redis, Arrow and Blessed dependencies\n- Updated all current dependencies\n- Added tests for Django 4.x and 5.x\n- Added Turkish language\n- Improved admin area\n- Fixed a lot of issues\n\nSee the `changelog \u003chttps://github.com/GDay/django-q2/blob/master/CHANGELOG.md\u003e`__ for all changes.\n\nRequirements\n~~~~~~~~~~~~\n\n-  `Django \u003chttps://www.djangoproject.com\u003e`__ \u003e = 4.2\n-  `Django-picklefield \u003chttps://github.com/gintas/django-picklefield\u003e`__\n\nTested with:\n\n* Python 3.9 to 3.13.\n* Django 4.2 to 5.2.\n\nBrokers\n~~~~~~~\n- `Redis \u003chttps://django-q2.readthedocs.org/en/latest/brokers.html#redis\u003e`__\n- `IronMQ \u003chttps://django-q2.readthedocs.org/en/latest/brokers.html#ironmq\u003e`__\n- `Amazon SQS \u003chttps://django-q2.readthedocs.org/en/latest/brokers.html#amazon-sqs\u003e`__\n- `MongoDB \u003chttps://django-q2.readthedocs.org/en/latest/brokers.html#mongodb\u003e`__\n- `Django ORM \u003chttps://django-q2.readthedocs.org/en/latest/brokers.html#django-orm\u003e`__\n\nInstallation\n~~~~~~~~~~~~\n\n-  Install the latest version with pip::\n\n    $ pip install django-q2\n\n\n-  Add `django_q` to your `INSTALLED_APPS` in your projects `settings.py`::\n\n       INSTALLED_APPS = (\n           # other apps\n           'django_q',\n       )\n\n-  Run Django migrations to create the database tables::\n\n    $ python manage.py migrate\n\n-  Choose a message `broker \u003chttps://django-q2.readthedocs.org/en/latest/brokers.html\u003e`__, configure and install the appropriate client library.\n\nRead the full documentation at `https://django-q2.readthedocs.org \u003chttps://django-q2.readthedocs.org\u003e`__\n\nConfiguration\n~~~~~~~~~~~~~\n\nAll configuration settings are optional. e.g:\n\n.. code:: python\n\n    # settings.py example\n    Q_CLUSTER = {\n        'name': 'myproject',\n        'workers': 8,\n        'recycle': 500,\n        'timeout': 60,\n        'compress': True,\n        'cpu_affinity': 1,\n        'save_limit': 250,\n        'queue_limit': 500,\n        'label': 'Django Q',\n        'redis': {\n            'host': '127.0.0.1',\n            'port': 6379,\n            'db': 0,\n        }\n    }\n\nFor full configuration options, see the `configuration documentation \u003chttps://django-q2.readthedocs.org/en/latest/configure.html\u003e`__.\n\nManagement Commands\n~~~~~~~~~~~~~~~~~~~\n\nFor the management commands to work, you will need to install Blessed: \u003chttps://github.com/jquast/blessed\u003e\n\nStart a cluster with::\n\n    $ python manage.py qcluster\n\nMonitor your clusters with::\n\n    $ python manage.py qmonitor\n\nMonitor your clusters' memory usage with::\n\n    $ python manage.py qmemory\n\nCheck overall statistics with::\n\n    $ python manage.py qinfo\n\nCreating Tasks\n~~~~~~~~~~~~~~\n\nUse `async_task` from your code to quickly offload tasks:\n\n.. code:: python\n\n    from django_q.tasks import async_task, result\n\n    # create the task\n    async_task('math.copysign', 2, -2)\n\n    # or with a reference\n    import math.copysign\n\n    task_id = async_task(copysign, 2, -2)\n\n    # get the result\n    task_result = result(task_id)\n\n    # result returns None if the task has not been executed yet\n    # you can wait for it\n    task_result = result(task_id, 200)\n\n    # but in most cases you will want to use a hook:\n\n    async_task('math.modf', 2.5, hook='hooks.print_result')\n\n    # hooks.py\n    def print_result(task):\n        print(task.result)\n\nFor more info see `Tasks \u003chttps://django-q2.readthedocs.org/en/latest/tasks.html\u003e`__\n\nSchedule\n~~~~~~~~\n\nSchedules are regular Django models. You can manage them through the\nAdmin page or directly from your code:\n\n.. code:: python\n\n    # Use the schedule function\n    from django_q.tasks import schedule\n\n    schedule('math.copysign',\n             2, -2,\n             hook='hooks.print_result',\n             schedule_type=Schedule.DAILY)\n\n    # Or create the object directly\n    from django_q.models import Schedule\n\n    Schedule.objects.create(func='math.copysign',\n                            hook='hooks.print_result',\n                            args='2,-2',\n                            schedule_type=Schedule.DAILY\n                            )\n\n    # Run a task every 5 minutes, starting at 6 today\n    # for 2 hours\n    from datetime import datetime\n\n    schedule('math.hypot',\n             3, 4,\n             schedule_type=Schedule.MINUTES,\n             minutes=5,\n             repeats=24,\n             next_run=datetime.utcnow().replace(hour=18, minute=0))\n\n    # Use a cron expression\n    schedule('math.hypot',\n             3, 4,\n             schedule_type=Schedule.CRON,\n             cron = '0 22 * * 1-5')\n\nFor more info check the `Schedules \u003chttps://django-q2.readthedocs.org/en/latest/schedules.html\u003e`__ documentation.\n\nDevelopment\n~~~~~~~~~~~\n\nThere is an example project that you can use to develop with. Docker (compose) is being used to set everything up.\nPlease note that you will have to restart the django-q container when changes have been made to tasks or django-q.\nYou can start the example project with:\n\n.. code:: bash\n\n    make dev\n\nCreate a superuser with:\n\n.. code:: bash\n\n    make createsuperuser\n\nTesting\n~~~~~~~\n\nRunning tests is easy with docker compose, it will also start the necessary databases. Just run:\n\n.. code:: bash\n\n    make test\n\nLocale\n~~~~~~\n\nCurrently available in English, German, Turkish, and French.\nTranslation pull requests are always welcome.\n\nAcknowledgements\n~~~~~~~~~~~~~~~~\n\n-  Django Q was inspired by working with\n   `Django-RQ \u003chttps://github.com/ui/django-rq\u003e`__ and\n   `RQ \u003chttps://github.com/ui/django-rq\u003e`__\n-  Human readable hashes by\n   `HumanHash \u003chttps://github.com/zacharyvoase/humanhash\u003e`__\n-  Redditors feedback at `r/django \u003chttps://www.reddit.com/r/django/\u003e`__\n\n-  JetBrains for their `Open Source Support Program \u003chttps://www.jetbrains.com/community/opensource\u003e`__\n\n.. |image0| image:: https://github.com/GDay/django-q2/actions/workflows/test.yml/badge.svg?branche=master\n   :target: https://github.com/GDay/django-q2/actions?query=workflow%3Atests\n.. |image1| image:: https://coveralls.io/repos/github/GDay/django-q2/badge.svg?branch=master\n   :target: https://coveralls.io/github/GDay/django-q2?branch=master\n.. |downloads| image:: https://img.shields.io/pypi/dm/django-q2\n   :target: https://img.shields.io/pypi/dm/django-q2\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjango-q2%2Fdjango-q2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdjango-q2%2Fdjango-q2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjango-q2%2Fdjango-q2/lists"}