edx-celeryutils
=============================
.. image:: https://img.shields.io/pypi/v/edx-celeryutils.svg
:target: https://pypi.python.org/pypi/edx-celeryutils/
:alt: PyPI
.. image:: https://github.com/openedx/edx-celeryutils/workflows/Python%20CI/badge.svg?branch=master
:target: https://github.com/openedx/edx-celeryutils/actions?query=workflow%3A%22Python+CI%22
:alt: CI
.. image:: http://codecov.io/github/edx/edx-celeryutils/coverage.svg?branch=master
:target: http://codecov.io/github/edx/edx-celeryutils?branch=master
:alt: Codecov
.. image:: http://edx-celeryutils.readthedocs.io/en/latest/?badge=latest
:target: http://edx-celeryutils.readthedocs.io/en/latest/
:alt: Documentation
.. image:: https://img.shields.io/pypi/pyversions/edx-celeryutils.svg
:target: https://pypi.python.org/pypi/edx-celeryutils/
:alt: Supported Python versions
.. image:: https://img.shields.io/github/license/edx/edx-celeryutils.svg
:target: https://github.com/openedx/edx-celeryutils/blob/master/LICENSE.txt
:alt: License
Code to support working with Celery, a distributed task queue.
Overview (please modify)
------------------------
This package contains utilities to wrap tasks with logging and to
persist them if they fail.
It also supports Django administration for searching and deleting
failed tasks, and management commands for rerunning failed tasks and
deleting old ones.
Documentation
-------------
(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
Publishing a Release
--------------------
After a PR merges, a new version of the package will automatically be released by Travis when the commit is tagged. Use::
git tag -a X.Y.Z -m "Releasing version X.Y.Z"
git push origin X.Y.Z
Do **not** create a Github Release, or ensure its message points to the CHANGELOG.rst.
License
-------
The code in this repository is licensed under the Apache 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 edx-celeryutils 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
~~~~~~~~~~
[1.3.0] - 2024-03-31
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Added python3.11 and 3.12 support. Dropped django32 support.
[1.2.5] - 2024-02-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Ran django-upgrade tool to add support for Django 4.2 in missing files.
[1.2.3] - 2023-06-15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Support added for Django 4.2.
* Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
deprecated
[1.2.2] - 2022-01-24
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Removed future package dependency.
[1.2.1] - 2022-01-24
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Updated celery constraint to <6.0 to fix make upgrade failure in edx-platform
[1.2.0] - 2022-01-19
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Removed Django22, 30, 31 support
* Added Support for Django40
[1.1.1] - 2021-08-24
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Replacing jsonfield2 with jsonfield as the former is merged back into the latter one.
[1.1.0] - 2021-07-07
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Added support for django 3.1 and 3.2
[1.0.0] - 2021-01-21
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Dropped python3.5 support.
[0.5.4] - 2020-12-10
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Upgrade celery to 5.0.4
[0.5.3] - 2020-09-15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Move to Apache 2.0 license
[0.5.2] - 2020-08-28
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Upgrade celery to 4.2.2
[0.5.1] - 2020-06-30
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Added python38 support.
[0.5.0] - 2020-04-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* No functional change.
[0.4.0] - 2020-03-05
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Removed all references to django-celery and removed it as a dependency.
* Removed ChordableDjangoBackend and ChordData.
[0.2.7] - 2017-12-04
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add logging for non-retried failed tasks.
[0.2.6] - 2017-08-07
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Upgrade version of django-celery.
[0.2.5] - 2017-08-03
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Django 1.11 compatibility
[0.2.4] - 2017-06-20
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add management command to fix djcelery tables.
[0.2.1] - 2017-05-22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add ChordableDjangoBackend and testing.
[0.1.3] - 2017-03-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Packaging changes.
[0.1.1] - 2017-02-22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Added django admin for management of FailedTasks.
[0.1.0] - 2017-01-31
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Initial release
Contains two task base classes:
* LoggedTask - Reports extra logging info 1) when a task is submitted to the task service (for tracking task latency) and 2) when the task retries, it surfaces information about the raised exception.
* PersistOnFailureTask - Stores a record of failed tasks that can later be retried.
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/edx-celeryutils",
"name": "edx-celeryutils",
"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/d8/0b/c1a2ae3d19917f5e71ac85efedfdfba17d30212f41397d805b6f5bd81a50/edx-celeryutils-1.3.0.tar.gz",
"platform": null,
"description": "edx-celeryutils\n=============================\n\n.. image:: https://img.shields.io/pypi/v/edx-celeryutils.svg\n :target: https://pypi.python.org/pypi/edx-celeryutils/\n :alt: PyPI\n\n.. image:: https://github.com/openedx/edx-celeryutils/workflows/Python%20CI/badge.svg?branch=master\n :target: https://github.com/openedx/edx-celeryutils/actions?query=workflow%3A%22Python+CI%22\n :alt: CI\n\n.. image:: http://codecov.io/github/edx/edx-celeryutils/coverage.svg?branch=master\n :target: http://codecov.io/github/edx/edx-celeryutils?branch=master\n :alt: Codecov\n\n.. image:: http://edx-celeryutils.readthedocs.io/en/latest/?badge=latest\n :target: http://edx-celeryutils.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. image:: https://img.shields.io/pypi/pyversions/edx-celeryutils.svg\n :target: https://pypi.python.org/pypi/edx-celeryutils/\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/github/license/edx/edx-celeryutils.svg\n :target: https://github.com/openedx/edx-celeryutils/blob/master/LICENSE.txt\n :alt: License\n\nCode to support working with Celery, a distributed task queue.\n\nOverview (please modify)\n------------------------\n\nThis package contains utilities to wrap tasks with logging and to\npersist them if they fail.\n\nIt also supports Django administration for searching and deleting\nfailed tasks, and management commands for rerunning failed tasks and\ndeleting old ones.\n\nDocumentation\n-------------\n\n(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)\n\nPublishing a Release\n--------------------\n\nAfter a PR merges, a new version of the package will automatically be released by Travis when the commit is tagged. Use::\n\n git tag -a X.Y.Z -m \"Releasing version X.Y.Z\"\n git push origin X.Y.Z\n\nDo **not** create a Github Release, or ensure its message points to the CHANGELOG.rst.\n\nLicense\n-------\n\nThe code in this repository is licensed under the Apache 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 edx-celeryutils 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[1.3.0] - 2024-03-31\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added python3.11 and 3.12 support. Dropped django32 support.\n\n[1.2.5] - 2024-02-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Ran django-upgrade tool to add support for Django 4.2 in missing files.\n\n[1.2.3] - 2023-06-15\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Support added for Django 4.2.\n* Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is\n deprecated\n\n[1.2.2] - 2022-01-24\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Removed future package dependency.\n\n[1.2.1] - 2022-01-24\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Updated celery constraint to <6.0 to fix make upgrade failure in edx-platform\n\n[1.2.0] - 2022-01-19\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Removed Django22, 30, 31 support\n* Added Support for Django40\n\n[1.1.1] - 2021-08-24\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Replacing jsonfield2 with jsonfield as the former is merged back into the latter one.\n\n[1.1.0] - 2021-07-07\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added support for django 3.1 and 3.2\n\n[1.0.0] - 2021-01-21\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Dropped python3.5 support.\n\n[0.5.4] - 2020-12-10\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Upgrade celery to 5.0.4\n\n[0.5.3] - 2020-09-15\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Move to Apache 2.0 license\n\n[0.5.2] - 2020-08-28\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Upgrade celery to 4.2.2\n\n[0.5.1] - 2020-06-30\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Added python38 support.\n\n[0.5.0] - 2020-04-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* No functional change.\n\n[0.4.0] - 2020-03-05\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Removed all references to django-celery and removed it as a dependency.\n* Removed ChordableDjangoBackend and ChordData.\n\n[0.2.7] - 2017-12-04\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Add logging for non-retried failed tasks.\n\n[0.2.6] - 2017-08-07\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Upgrade version of django-celery.\n\n[0.2.5] - 2017-08-03\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Django 1.11 compatibility\n\n[0.2.4] - 2017-06-20\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Add management command to fix djcelery tables.\n\n[0.2.1] - 2017-05-22\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Add ChordableDjangoBackend and testing.\n\n[0.1.3] - 2017-03-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Packaging changes.\n\n[0.1.1] - 2017-02-22\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* Added django admin for management of FailedTasks.\n\n[0.1.0] - 2017-01-31\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nInitial release\n\nContains two task base classes:\n\n* LoggedTask - Reports extra logging info 1) when a task is submitted to the task service (for tracking task latency) and 2) when the task retries, it surfaces information about the raised exception.\n* PersistOnFailureTask - Stores a record of failed tasks that can later be retried.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Code to support working with celery",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://github.com/openedx/edx-celeryutils"
},
"split_keywords": [
"django",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d071f9f384910eca049c2bc6c2e38cd7b594a75b8d003b50d258ed565a35f74c",
"md5": "7ce142879d7d7a237e634f3117b36071",
"sha256": "5f75c88a5a13e8141097068e45b2737f4a1caa2b667dc551f99d5e928dafd0ba"
},
"downloads": -1,
"filename": "edx_celeryutils-1.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ce142879d7d7a237e634f3117b36071",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 17840,
"upload_time": "2024-04-01T19:51:27",
"upload_time_iso_8601": "2024-04-01T19:51:27.602760Z",
"url": "https://files.pythonhosted.org/packages/d0/71/f9f384910eca049c2bc6c2e38cd7b594a75b8d003b50d258ed565a35f74c/edx_celeryutils-1.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d80bc1a2ae3d19917f5e71ac85efedfdfba17d30212f41397d805b6f5bd81a50",
"md5": "36a0507e154dd9bc7c86eb5ac91eb6fd",
"sha256": "d1533d997c7a53a434d6f6dd3ac8a9c75f1c78f8351eba99fb76b56125172028"
},
"downloads": -1,
"filename": "edx-celeryutils-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "36a0507e154dd9bc7c86eb5ac91eb6fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19157,
"upload_time": "2024-04-01T19:51:36",
"upload_time_iso_8601": "2024-04-01T19:51:36.696490Z",
"url": "https://files.pythonhosted.org/packages/d8/0b/c1a2ae3d19917f5e71ac85efedfdfba17d30212f41397d805b6f5bd81a50/edx-celeryutils-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 19:51:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "edx-celeryutils",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "edx-celeryutils"
}
JSON
