django-user-tasks
=================
.. image:: https://img.shields.io/pypi/v/django-user-tasks.svg
:target: https://pypi.python.org/pypi/django-user-tasks/
:alt: PyPI
.. image:: https://github.com/openedx/django-user-tasks/workflows/Python%20CI/badge.svg?branch=master
:target: https://github.com/openedx/django-user-tasks/actions?query=workflow%3A%22Python+CI%22
:alt: CI
.. image:: http://codecov.io/github/edx/django-user-tasks/coverage.svg?branch=master
:target: http://codecov.io/github/edx/django-user-tasks?branch=master
:alt: Codecov
.. image:: https://readthedocs.org/projects/django-user-tasks/badge/?version=latest
:target: http://django-user-tasks.readthedocs.io/en/latest/
:alt: Documentation
.. image:: https://img.shields.io/pypi/pyversions/django-user-tasks.svg
:target: https://pypi.python.org/pypi/django-user-tasks/
:alt: Supported Python versions
.. image:: https://img.shields.io/github/license/edx/django-user-tasks.svg
:target: https://github.com/openedx/django-user-tasks/blob/master/LICENSE.txt
:alt: License
django-user-tasks is a reusable Django application for managing user-triggered
asynchronous tasks. It provides a status page for each such task, which
includes a meaningful progress indicator if the task is currently being
executed and provides any appropriate text and/or links for output once the
task is complete.
In Open edX, such tasks include operations such as exporting or importing a
course, sending an email to all the students in a course, uploading a video,
and other tasks which often take too long to perform during a single web
request (as outlined in `OEP-3`_). However, this has been written with the
intention of being useful in a variety of Django projects outside the Open edX
platform as well.
Note that this library was created as a consolidation of lessons learned from
implementing such tasks in various parts of the Open edX code base. They
don't yet all use this library, but the plan is to over time refactor many of
them to do so.
.. _OEP-3: https://open-edx-proposals.readthedocs.io/en/latest/oeps/oep-0003.html
Overview
--------
django-user-tasks is currently a wrapper for `Celery`_ (although the hope is
that it could also be extended to also support `channels`_ and other
asynchronous task queues). By extending the provided ``UserTask`` class (or
adding ``UserTaskMixin`` to an existing Task subclass) and providing a
``user_id`` task argument, the task's status is stored in a database table
separate from the Celery broker and result store. This ``UserTaskStatus``
model allows for full database queries of the tasks that users are most likely
to care about while not imposing any restrictions on the Celery configuration
most appropriate for the site's overall needs for asynchronous task
processing.
Most of the status updating is handled automatically via Celery's `signals`_
mechanism, but it can be enhanced by:
* Overriding the ``UserTaskMixin`` methods such as ``generate_name`` and
``calculate_total_steps`` for particular types of tasks
* Calling some of the ``UserTaskStatus`` methods like
``increment_completed_steps`` and ``set_state`` from the task implementation
* Saving task output as instances of the ``UserTaskArtifact`` model
.. _Celery: http://www.celeryproject.org/
.. _channels: https://channels.readthedocs.io/en/latest/
.. _signals: http://docs.celeryproject.org/en/latest/userguide/signals.html
Documentation
-------------
The full documentation is at https://django-user-tasks.readthedocs.org.
License
-------
The code in this repository is licensed under the Apache Software License 2.0 unless
otherwise noted.
Please see ``LICENSE.txt`` for details.
How To Contribute
-----------------
Contributions are very welcome.
Please read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`_ for details.
Reporting Security Issues
-------------------------
Please do not report security issues in public. Please email security@openedx.org.
Getting Help
------------
Have a question about this repository, or about Open edX in general? Please
refer to this `list of resources`_ if you need any assistance.
.. _list of resources: https://open.edx.org/getting-help
Change Log
----------
..
All enhancements and patches to django-user-tasks will be documented
in this file. It adheres to the structure of http://keepachangelog.com/ ,
but in reStructuredText instead of Markdown (for ease of incorporation into
Sphinx documentation and the PyPI description).
This project adheres to Semantic Versioning (http://semver.org/).
.. There should always be an "Unreleased" section for changes pending release.
Unreleased
~~~~~~~~~~
[3.2.0] - 2024-03-12
~~~~~~~~~~~~~~~~~~~~
Added
+++++
* Adding python 3.11 support.
* Adding python 3.12 support.
* Removed django32 support.
[3.1.0] - 2023-07-21
~~~~~~~~~~~~~~~~~~~~
Added
+++++
* Added Django42 support in CI.
Removed
+++++++
* Removed old versions of celery and drf version from ci.
Chore
+++++
* Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
deprecated
[3.0.0] - 2022-02-09
~~~~~~~~~~~~~~~~~~~~
Removed
+++++++
* Removed Python 3.5 support.
Chore
+++++
* Upgraded celery to latest 5.x version.
[2.2.0] - 2022-01-26
~~~~~~~~~~~~~~~~~~~~
Removed
+++++++
* Removed Django22,30,31 support.
Added
+++++
* Added Django40 support in CI
[2.1.0] - 2021-07-07
~~~~~~~~~~~~~~~~~~~~
Added
+++++
* Support for django3.0, 3.1 and 3.2
[2.0.3] - 2021-06-08
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Fixed django admin timeout issue.
[2.0.2] - 2021-05-28
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Fixed minor issue. If links key is not available assign empty list. Added logs.
[2.0.1] - 2021-05-28
~~~~~~~~~~~~~~~~~~~~
Added
+++++++
* Added celery5.0 testing with tox. Update the import task command compatible with both celery 4.4.7 and celery5.0.
[2.0.0] - 2021-01-20
~~~~~~~~~~~~~~~~~~~~
Removed
+++++++
* Removed python3.5 support.
[1.3.2] - 2020-12-17
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Added celery 5.0 testing using tox. Fix pylint warnings. Update the code accordingly.
[1.3.2] - 2020-12-17
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Updated the deprecated celery import class. New import is compatible with 4.4.7 also.
[1.3.1] - 2020-11-23
~~~~~~~~~~~~~~~~~~~~
Added
+++++
* Added support for Django REST Framework 3.10.x through 3.12.x
[1.3.0] - 2020-08-25
~~~~~~~~~~~~~~~~~~~~
Added
+++++
* Added support for celery 4
[1.2.0] - 2020-08-20
~~~~~~~~~~~~~~~~~~~~
Removed
+++++++
* Removed code related to Python 2
[1.1.0] - 2020-05-07
~~~~~~~~~~~~~~~~~~~~
Added
+++++++
* Added support for python 3.8
Removed
+++++++
* Dropped support for Django < 2.2
[1.0.0] - 2020-03-18
~~~~~~~~~~~~~~~~~~~~
Removed
+++++++
* Dropped Python 2.7 support
[0.3.0] - 2019-12-15
~~~~~~~~~~~~~~~~~~~~
Added
+++++
* Added support for Django 2.2
[0.2.1] - 2019-09-25
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* `start_user_task` should only close obsolete connections if the current connection is NOT in an atomic block
(which fixes errors on devstack studio/course-publishing).
[0.2.0] - 2019-08-30
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Have the `start_user_task` receiver close obsolete connections before starting the task.
[0.1.9] - 2019-08-27
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Fix issue with `UserTaskArtifactAdmin` and `UserTaskStatusAdmin` where `ordering` attribute must be a tuple or list.
[0.1.8] - 2019-08-22
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Improve list display for `ModelAdmin`.
[0.1.7] - 2019-05-29
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Make ``UserTaskArtifact.url`` a ``TextField`` with a ``URLValidator``
instead of a ``URLField``.
[0.1.6] - 2019-05-29
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Upgrade requirements.
* Change ``max_length`` of ``UserTaskArtifact.url`` from 200 to 512.
[0.1.5] - 2017-08-03
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Added testing/support for Django 1.11.
[0.1.4] - 2017-01-30
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Slightly improved handling of tasks which start before their status records
are committed (due to database transactions). Also documented how to avoid
this problem in the first place.
[0.1.3] - 2017-01-03
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Tasks which were explicitly canceled, failed, or retried no longer have
their status changed to ``Succeeded`` just because the task exited cleanly.
* Celery tasks which fail to import cleanly by name (because they use a custom
name which isn't actually the fully qualified task name) are now just ignored
in the ``before_task_publish`` signal handler.
[0.1.2] - 2016-12-05
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Add a migration to explicitly reference the setting for artifact file storage.
This setting is likely to vary between installations, but doesn't affect the
generated database schema. This change should prevent ``makemigrations``
from creating a new migration whenever the setting value changes.
[0.1.1] - 2016-10-11
~~~~~~~~~~~~~~~~~~~~
Changed
+++++++
* Fix Travis configuration for PyPI deployments.
* Switch from the Read the Docs Sphinx theme to the Open edX one for documentation.
[0.1.0] - 2016-10-07
~~~~~~~~~~~~~~~~~~~~
Added
+++++
* First attempt to release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/django-user-tasks",
"name": "django-user-tasks",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Django edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/72/92/24cd6e6f51e9a3dc5396be255eb8f66ff479448fd600b2b9ea7e5f286673/django-user-tasks-3.2.0.tar.gz",
"platform": null,
"description": "django-user-tasks\n=================\n\n.. image:: https://img.shields.io/pypi/v/django-user-tasks.svg\n :target: https://pypi.python.org/pypi/django-user-tasks/\n :alt: PyPI\n\n.. image:: https://github.com/openedx/django-user-tasks/workflows/Python%20CI/badge.svg?branch=master\n :target: https://github.com/openedx/django-user-tasks/actions?query=workflow%3A%22Python+CI%22\n :alt: CI\n\n.. image:: http://codecov.io/github/edx/django-user-tasks/coverage.svg?branch=master\n :target: http://codecov.io/github/edx/django-user-tasks?branch=master\n :alt: Codecov\n\n.. image:: https://readthedocs.org/projects/django-user-tasks/badge/?version=latest\n :target: http://django-user-tasks.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. image:: https://img.shields.io/pypi/pyversions/django-user-tasks.svg\n :target: https://pypi.python.org/pypi/django-user-tasks/\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/github/license/edx/django-user-tasks.svg\n :target: https://github.com/openedx/django-user-tasks/blob/master/LICENSE.txt\n :alt: License\n\ndjango-user-tasks is a reusable Django application for managing user-triggered\nasynchronous tasks. It provides a status page for each such task, which\nincludes a meaningful progress indicator if the task is currently being\nexecuted and provides any appropriate text and/or links for output once the\ntask is complete.\n\nIn Open edX, such tasks include operations such as exporting or importing a\ncourse, sending an email to all the students in a course, uploading a video,\nand other tasks which often take too long to perform during a single web\nrequest (as outlined in `OEP-3`_). However, this has been written with the\nintention of being useful in a variety of Django projects outside the Open edX\nplatform as well.\n\nNote that this library was created as a consolidation of lessons learned from\nimplementing such tasks in various parts of the Open edX code base. They\ndon't yet all use this library, but the plan is to over time refactor many of\nthem to do so.\n\n.. _OEP-3: https://open-edx-proposals.readthedocs.io/en/latest/oeps/oep-0003.html\n\nOverview\n--------\n\ndjango-user-tasks is currently a wrapper for `Celery`_ (although the hope is\nthat it could also be extended to also support `channels`_ and other\nasynchronous task queues). By extending the provided ``UserTask`` class (or\nadding ``UserTaskMixin`` to an existing Task subclass) and providing a\n``user_id`` task argument, the task's status is stored in a database table\nseparate from the Celery broker and result store. This ``UserTaskStatus``\nmodel allows for full database queries of the tasks that users are most likely\nto care about while not imposing any restrictions on the Celery configuration\nmost appropriate for the site's overall needs for asynchronous task\nprocessing.\n\nMost of the status updating is handled automatically via Celery's `signals`_\nmechanism, but it can be enhanced by:\n\n* Overriding the ``UserTaskMixin`` methods such as ``generate_name`` and\n ``calculate_total_steps`` for particular types of tasks\n* Calling some of the ``UserTaskStatus`` methods like\n ``increment_completed_steps`` and ``set_state`` from the task implementation\n* Saving task output as instances of the ``UserTaskArtifact`` model\n\n.. _Celery: http://www.celeryproject.org/\n.. _channels: https://channels.readthedocs.io/en/latest/\n.. _signals: http://docs.celeryproject.org/en/latest/userguide/signals.html\n\nDocumentation\n-------------\n\nThe full documentation is at https://django-user-tasks.readthedocs.org.\n\nLicense\n-------\n\nThe code in this repository is licensed under the Apache Software License 2.0 unless\notherwise noted.\n\nPlease see ``LICENSE.txt`` for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome.\n\nPlease read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`_ for details.\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\nGetting Help\n------------\n\nHave a question about this repository, or about Open edX in general? Please\nrefer to this `list of resources`_ if you need any assistance.\n\n.. _list of resources: https://open.edx.org/getting-help\n\n\nChange Log\n----------\n\n..\n All enhancements and patches to django-user-tasks will be documented\n in this file. It adheres to the structure of http://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n\n This project adheres to Semantic Versioning (http://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n~~~~~~~~~~\n\n[3.2.0] - 2024-03-12\n~~~~~~~~~~~~~~~~~~~~\n\nAdded\n+++++\n* Adding python 3.11 support.\n* Adding python 3.12 support.\n* Removed django32 support.\n\n[3.1.0] - 2023-07-21\n~~~~~~~~~~~~~~~~~~~~\n\nAdded\n+++++\n* Added Django42 support in CI.\n\nRemoved\n+++++++\n* Removed old versions of celery and drf version from ci.\n\nChore\n+++++\n* Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is\n deprecated\n\n[3.0.0] - 2022-02-09\n~~~~~~~~~~~~~~~~~~~~\n\nRemoved\n+++++++\n* Removed Python 3.5 support.\n\nChore\n+++++\n* Upgraded celery to latest 5.x version.\n\n[2.2.0] - 2022-01-26\n~~~~~~~~~~~~~~~~~~~~\n\nRemoved\n+++++++\n\n* Removed Django22,30,31 support.\n\nAdded\n+++++\n\n* Added Django40 support in CI\n\n[2.1.0] - 2021-07-07\n~~~~~~~~~~~~~~~~~~~~\n\nAdded\n+++++\n\n* Support for django3.0, 3.1 and 3.2\n\n[2.0.3] - 2021-06-08\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Fixed django admin timeout issue.\n\n[2.0.2] - 2021-05-28\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Fixed minor issue. If links key is not available assign empty list. Added logs.\n\n\n[2.0.1] - 2021-05-28\n~~~~~~~~~~~~~~~~~~~~\n\nAdded\n+++++++\n\n* Added celery5.0 testing with tox. Update the import task command compatible with both celery 4.4.7 and celery5.0.\n\n\n[2.0.0] - 2021-01-20\n~~~~~~~~~~~~~~~~~~~~\n\nRemoved\n+++++++\n\n* Removed python3.5 support.\n\n\n[1.3.2] - 2020-12-17\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Added celery 5.0 testing using tox. Fix pylint warnings. Update the code accordingly.\n\n\n[1.3.2] - 2020-12-17\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Updated the deprecated celery import class. New import is compatible with 4.4.7 also.\n\n\n[1.3.1] - 2020-11-23\n~~~~~~~~~~~~~~~~~~~~\n\nAdded\n+++++\n\n* Added support for Django REST Framework 3.10.x through 3.12.x\n\n[1.3.0] - 2020-08-25\n~~~~~~~~~~~~~~~~~~~~\n\nAdded\n+++++\n\n* Added support for celery 4\n\n[1.2.0] - 2020-08-20\n~~~~~~~~~~~~~~~~~~~~\n\nRemoved\n+++++++\n\n* Removed code related to Python 2\n\n\n[1.1.0] - 2020-05-07\n~~~~~~~~~~~~~~~~~~~~\n\nAdded\n+++++++\n\n* Added support for python 3.8\n\nRemoved\n+++++++\n\n* Dropped support for Django < 2.2\n\n[1.0.0] - 2020-03-18\n~~~~~~~~~~~~~~~~~~~~\n\nRemoved\n+++++++\n\n* Dropped Python 2.7 support\n\n[0.3.0] - 2019-12-15\n~~~~~~~~~~~~~~~~~~~~\n\nAdded\n+++++\n\n* Added support for Django 2.2\n\n[0.2.1] - 2019-09-25\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* `start_user_task` should only close obsolete connections if the current connection is NOT in an atomic block\n (which fixes errors on devstack studio/course-publishing).\n\n[0.2.0] - 2019-08-30\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Have the `start_user_task` receiver close obsolete connections before starting the task.\n\n\n[0.1.9] - 2019-08-27\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Fix issue with `UserTaskArtifactAdmin` and `UserTaskStatusAdmin` where `ordering` attribute must be a tuple or list.\n\n\n[0.1.8] - 2019-08-22\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Improve list display for `ModelAdmin`.\n\n\n[0.1.7] - 2019-05-29\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Make ``UserTaskArtifact.url`` a ``TextField`` with a ``URLValidator``\n instead of a ``URLField``.\n\n\n[0.1.6] - 2019-05-29\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Upgrade requirements.\n* Change ``max_length`` of ``UserTaskArtifact.url`` from 200 to 512.\n\n\n[0.1.5] - 2017-08-03\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Added testing/support for Django 1.11.\n\n[0.1.4] - 2017-01-30\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Slightly improved handling of tasks which start before their status records\n are committed (due to database transactions). Also documented how to avoid\n this problem in the first place.\n\n[0.1.3] - 2017-01-03\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Tasks which were explicitly canceled, failed, or retried no longer have\n their status changed to ``Succeeded`` just because the task exited cleanly.\n* Celery tasks which fail to import cleanly by name (because they use a custom\n name which isn't actually the fully qualified task name) are now just ignored\n in the ``before_task_publish`` signal handler.\n\n[0.1.2] - 2016-12-05\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Add a migration to explicitly reference the setting for artifact file storage.\n This setting is likely to vary between installations, but doesn't affect the\n generated database schema. This change should prevent ``makemigrations``\n from creating a new migration whenever the setting value changes.\n\n[0.1.1] - 2016-10-11\n~~~~~~~~~~~~~~~~~~~~\n\nChanged\n+++++++\n\n* Fix Travis configuration for PyPI deployments.\n* Switch from the Read the Docs Sphinx theme to the Open edX one for documentation.\n\n\n[0.1.0] - 2016-10-07\n~~~~~~~~~~~~~~~~~~~~\n\nAdded\n+++++\n\n* First attempt to release on PyPI.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Management of user-triggered asynchronous tasks in Django projects",
"version": "3.2.0",
"project_urls": {
"Homepage": "https://github.com/openedx/django-user-tasks"
},
"split_keywords": [
"django",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df533aac20228cebc2cac74a69d928cce99cb04c7fed0f7b0b0f94ee9cf7593c",
"md5": "2726ea35ecc7317993cf2889eab95e6f",
"sha256": "143c8c6d1be8c169450ffc9eca059d70d67732a26881806fbeb640def23a64f3"
},
"downloads": -1,
"filename": "django_user_tasks-3.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2726ea35ecc7317993cf2889eab95e6f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 26911,
"upload_time": "2024-03-29T14:19:37",
"upload_time_iso_8601": "2024-03-29T14:19:37.915758Z",
"url": "https://files.pythonhosted.org/packages/df/53/3aac20228cebc2cac74a69d928cce99cb04c7fed0f7b0b0f94ee9cf7593c/django_user_tasks-3.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "729224cd6e6f51e9a3dc5396be255eb8f66ff479448fd600b2b9ea7e5f286673",
"md5": "206b8e498b2edcf4b88d07e38ffd45bf",
"sha256": "7a0bf998bad3934f2201c6804714a5a5596219fa58252b8486f8f31162ac3eb8"
},
"downloads": -1,
"filename": "django-user-tasks-3.2.0.tar.gz",
"has_sig": false,
"md5_digest": "206b8e498b2edcf4b88d07e38ffd45bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31983,
"upload_time": "2024-03-29T14:19:39",
"upload_time_iso_8601": "2024-03-29T14:19:39.759384Z",
"url": "https://files.pythonhosted.org/packages/72/92/24cd6e6f51e9a3dc5396be255eb8f66ff479448fd600b2b9ea7e5f286673/django-user-tasks-3.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 14:19:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "django-user-tasks",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "django-user-tasks"
}
JSON
