A multiprocessing distributed task queue for Django
---------------------------------------------------
|image0| |image1| |docs| |downloads|
::
Django 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
Features
~~~~~~~~
- Multiprocessing worker pool
- Asynchronous tasks
- Scheduled, cron and repeated tasks
- Signed and compressed packages
- Failure and success database or cache
- Result hooks, groups and chains
- Django Admin integration
- PaaS compatible with multiple instances
- Multi cluster monitor
- Redis, IronMQ, SQS, MongoDB or ORM
- Rollbar and Sentry support
Changes compared to the original Django-Q:
- Dropped support for Disque (hasn't been updated in a long time)
- Dropped Redis, Arrow and Blessed dependencies
- Updated all current dependencies
- Added tests for Django 4.x and 5.x
- Added Turkish language
- Improved admin area
- Fixed a lot of issues
See the `changelog <https://github.com/GDay/django-q2/blob/master/CHANGELOG.md>`__ for all changes.
Requirements
~~~~~~~~~~~~
- `Django <https://www.djangoproject.com>`__ > = 3.2
- `Django-picklefield <https://github.com/gintas/django-picklefield>`__
Tested with: Python 3.8, 3.9, 3.10, 3.11 and 3.12. Works with Django 3.2.X, 4.1.X, 4.2.X and 5.0.X
Brokers
~~~~~~~
- `Redis <https://django-q2.readthedocs.org/en/latest/brokers.html#redis>`__
- `IronMQ <https://django-q2.readthedocs.org/en/latest/brokers.html#ironmq>`__
- `Amazon SQS <https://django-q2.readthedocs.org/en/latest/brokers.html#amazon-sqs>`__
- `MongoDB <https://django-q2.readthedocs.org/en/latest/brokers.html#mongodb>`__
- `Django ORM <https://django-q2.readthedocs.org/en/latest/brokers.html#django-orm>`__
Installation
~~~~~~~~~~~~
- Install the latest version with pip::
$ pip install django-q2
- Add `django_q` to your `INSTALLED_APPS` in your projects `settings.py`::
INSTALLED_APPS = (
# other apps
'django_q',
)
- Run Django migrations to create the database tables::
$ python manage.py migrate
- Choose a message `broker <https://django-q2.readthedocs.org/en/latest/brokers.html>`__, configure and install the appropriate client library.
Read the full documentation at `https://django-q2.readthedocs.org <https://django-q2.readthedocs.org>`__
Configuration
~~~~~~~~~~~~~
All configuration settings are optional. e.g:
.. code:: python
# settings.py example
Q_CLUSTER = {
'name': 'myproject',
'workers': 8,
'recycle': 500,
'timeout': 60,
'compress': True,
'cpu_affinity': 1,
'save_limit': 250,
'queue_limit': 500,
'label': 'Django Q',
'redis': {
'host': '127.0.0.1',
'port': 6379,
'db': 0,
}
}
For full configuration options, see the `configuration documentation <https://django-q2.readthedocs.org/en/latest/configure.html>`__.
Management Commands
~~~~~~~~~~~~~~~~~~~
::
For the management commands to work, you will need to install Blessed: <https://github.com/jquast/blessed>
Start a cluster with::
$ python manage.py qcluster
Monitor your clusters with::
$ python manage.py qmonitor
Monitor your clusters' memory usage with::
$ python manage.py qmemory
Check overall statistics with::
$ python manage.py qinfo
Creating Tasks
~~~~~~~~~~~~~~
Use `async_task` from your code to quickly offload tasks:
.. code:: python
from django_q.tasks import async_task, result
# create the task
async_task('math.copysign', 2, -2)
# or with a reference
import math.copysign
task_id = async_task(copysign, 2, -2)
# get the result
task_result = result(task_id)
# result returns None if the task has not been executed yet
# you can wait for it
task_result = result(task_id, 200)
# but in most cases you will want to use a hook:
async_task('math.modf', 2.5, hook='hooks.print_result')
# hooks.py
def print_result(task):
print(task.result)
For more info see `Tasks <https://django-q2.readthedocs.org/en/latest/tasks.html>`__
Schedule
~~~~~~~~
Schedules are regular Django models. You can manage them through the
Admin page or directly from your code:
.. code:: python
# Use the schedule function
from django_q.tasks import schedule
schedule('math.copysign',
2, -2,
hook='hooks.print_result',
schedule_type=Schedule.DAILY)
# Or create the object directly
from django_q.models import Schedule
Schedule.objects.create(func='math.copysign',
hook='hooks.print_result',
args='2,-2',
schedule_type=Schedule.DAILY
)
# Run a task every 5 minutes, starting at 6 today
# for 2 hours
from datetime import datetime
schedule('math.hypot',
3, 4,
schedule_type=Schedule.MINUTES,
minutes=5,
repeats=24,
next_run=datetime.utcnow().replace(hour=18, minute=0))
# Use a cron expression
schedule('math.hypot',
3, 4,
schedule_type=Schedule.CRON,
cron = '0 22 * * 1-5')
For more info check the `Schedules <https://django-q2.readthedocs.org/en/latest/schedules.html>`__ documentation.
Testing
~~~~~~~
Running tests is easy with docker compose, it will also start the necessary databases. Just run:
.. code:: bash
docker-compose -f test-services-docker-compose.yaml run --rm django-q2 poetry run pytest
Locale
~~~~~~
Currently available in English, German, Turkish, and French.
Translation pull requests are always welcome.
Todo
~~~~
- Better tests and coverage
- Less dependencies?
Acknowledgements
~~~~~~~~~~~~~~~~
- Django Q was inspired by working with
`Django-RQ <https://github.com/ui/django-rq>`__ and
`RQ <https://github.com/ui/django-rq>`__
- Human readable hashes by
`HumanHash <https://github.com/zacharyvoase/humanhash>`__
- Redditors feedback at `r/django <https://www.reddit.com/r/django/>`__
- JetBrains for their `Open Source Support Program <https://www.jetbrains.com/community/opensource>`__
.. |image0| image:: https://github.com/GDay/django-q2/actions/workflows/test.yml/badge.svg?branche=master
:target: https://github.com/GDay/django-q2/actions?query=workflow%3Atests
.. |image1| image:: https://coveralls.io/repos/github/GDay/django-q2/badge.svg?branch=master
:target: https://coveralls.io/github/GDay/django-q2?branch=master
.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest
:alt: Documentation Status
:scale: 100
:target: https://django-q2.readthedocs.org/
.. |downloads| image:: https://img.shields.io/pypi/dm/django-q2
:target: https://img.shields.io/pypi/dm/django-q2
Raw data
{
"_id": null,
"home_page": "https://django-q2.readthedocs.org",
"name": "django-q2",
"maintainer": "Stan Triepels",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "django-q2@stantriepels.com",
"keywords": "django,distributed,multiprocessing,queue,scheduler",
"author": "Stan Triepels",
"author_email": "django-q2@stantriepels.com",
"download_url": "https://files.pythonhosted.org/packages/c9/7e/d1ee08f36213640f571c6887bd9eaf34abb7cd174fc2f79c3bb0c190f359/django_q2-1.6.1.tar.gz",
"platform": null,
"description": "A multiprocessing distributed task queue for Django\n---------------------------------------------------\n\n|image0| |image1| |docs| |downloads|\n\n::\n\n Django 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 <https://github.com/GDay/django-q2/blob/master/CHANGELOG.md>`__ for all changes.\n\nRequirements\n~~~~~~~~~~~~\n\n- `Django <https://www.djangoproject.com>`__ > = 3.2\n- `Django-picklefield <https://github.com/gintas/django-picklefield>`__\n\nTested with: Python 3.8, 3.9, 3.10, 3.11 and 3.12. Works with Django 3.2.X, 4.1.X, 4.2.X and 5.0.X\n\nBrokers\n~~~~~~~\n- `Redis <https://django-q2.readthedocs.org/en/latest/brokers.html#redis>`__\n- `IronMQ <https://django-q2.readthedocs.org/en/latest/brokers.html#ironmq>`__\n- `Amazon SQS <https://django-q2.readthedocs.org/en/latest/brokers.html#amazon-sqs>`__\n- `MongoDB <https://django-q2.readthedocs.org/en/latest/brokers.html#mongodb>`__\n- `Django ORM <https://django-q2.readthedocs.org/en/latest/brokers.html#django-orm>`__\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 <https://django-q2.readthedocs.org/en/latest/brokers.html>`__, configure and install the appropriate client library.\n\nRead the full documentation at `https://django-q2.readthedocs.org <https://django-q2.readthedocs.org>`__\n\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 <https://django-q2.readthedocs.org/en/latest/configure.html>`__.\n\nManagement Commands\n~~~~~~~~~~~~~~~~~~~\n\n::\n\n For the management commands to work, you will need to install Blessed: <https://github.com/jquast/blessed>\n\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 <https://django-q2.readthedocs.org/en/latest/tasks.html>`__\n\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 <https://django-q2.readthedocs.org/en/latest/schedules.html>`__ documentation.\n\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 docker-compose -f test-services-docker-compose.yaml run --rm django-q2 poetry run pytest\n\nLocale\n~~~~~~\n\nCurrently available in English, German, Turkish, and French.\nTranslation pull requests are always welcome.\n\nTodo\n~~~~\n\n- Better tests and coverage\n- Less dependencies?\n\nAcknowledgements\n~~~~~~~~~~~~~~~~\n\n- Django Q was inspired by working with\n `Django-RQ <https://github.com/ui/django-rq>`__ and\n `RQ <https://github.com/ui/django-rq>`__\n- Human readable hashes by\n `HumanHash <https://github.com/zacharyvoase/humanhash>`__\n- Redditors feedback at `r/django <https://www.reddit.com/r/django/>`__\n\n- JetBrains for their `Open Source Support Program <https://www.jetbrains.com/community/opensource>`__\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.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest\n :alt: Documentation Status\n :scale: 100\n :target: https://django-q2.readthedocs.org/\n.. |downloads| image:: https://img.shields.io/pypi/dm/django-q2\n :target: https://img.shields.io/pypi/dm/django-q2\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A multiprocessing distributed task queue for Django",
"version": "1.6.1",
"project_urls": {
"Documentation": "https://django-q2.readthedocs.org",
"Homepage": "https://django-q2.readthedocs.org",
"Repository": "https://github.com/GDay/django-q2"
},
"split_keywords": [
"django",
"distributed",
"multiprocessing",
"queue",
"scheduler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a100080332276ea7cf3289a277e3655096799e721002c2eae6083ae170d266d",
"md5": "e7d46a1af6cadfafe24fe1c82713995e",
"sha256": "0944b6cbb73671d471fa970a3807e294d750a224764986cff5bff0fe6daa7f7d"
},
"downloads": -1,
"filename": "django_q2-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7d46a1af6cadfafe24fe1c82713995e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 100956,
"upload_time": "2023-10-13T12:21:11",
"upload_time_iso_8601": "2023-10-13T12:21:11.271740Z",
"url": "https://files.pythonhosted.org/packages/2a/10/0080332276ea7cf3289a277e3655096799e721002c2eae6083ae170d266d/django_q2-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c97ed1ee08f36213640f571c6887bd9eaf34abb7cd174fc2f79c3bb0c190f359",
"md5": "10f87c6de763f9d06254a546ea9d41ad",
"sha256": "38fa67e5f75d172ef59a1edcc891cb5f8f0fb863f95a6ada4c44dd3f2d5bda53"
},
"downloads": -1,
"filename": "django_q2-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "10f87c6de763f9d06254a546ea9d41ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 76652,
"upload_time": "2023-10-13T12:21:13",
"upload_time_iso_8601": "2023-10-13T12:21:13.624827Z",
"url": "https://files.pythonhosted.org/packages/c9/7e/d1ee08f36213640f571c6887bd9eaf34abb7cd174fc2f79c3bb0c190f359/django_q2-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-13 12:21:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GDay",
"github_project": "django-q2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "django-q2"
}
JSON
