edx-celeryutils

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 [e-mail].

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.