Metadata-Version: 2.1
Name: edx-celeryutils
Version: 0.5.0
Summary: Code to support working with celery
Home-page: https://github.com/edx/edx-celeryutils
Author: edX
Author-email: oscm@edx.org
License: AGPL 3.0
Keywords: Django edx
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: future
Requires-Dist: django-model-utils
Requires-Dist: jsonfield2
Requires-Dist: celery (<4.0,>=3.1.25)
Requires-Dist: Django (<2.3,>=1.11)

edx-celeryutils
=============================

.. image:: https://img.shields.io/pypi/v/edx-celeryutils.svg
    :target: https://pypi.python.org/pypi/edx-celeryutils/
    :alt: PyPI

.. image:: https://travis-ci.org/edx/edx-celeryutils.svg?branch=master
    :target: https://travis-ci.org/edx/edx-celeryutils
    :alt: Travis

.. 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/edx/edx-celeryutils/blob/master/LICENSE.txt
    :alt: License

The ``README.rst`` file should start with a brief description of the repository,
which sets it in the context of other repositories under the ``edx``
organization. It should make clear where this fits in to the overall edX
codebase.

Code to support working with celery

Overview (please modify)
------------------------

The ``README.rst`` file should then provide an overview of the code in this
repository, including the main components and useful entry points for starting
to understand the code in more detail.

Documentation
-------------

The full documentation is at https://edx-celeryutils.readthedocs.org.

License
-------

The code in this repository is licensed under the AGPL 3.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/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.

Even though they were written with ``edx-platform`` in mind, the guidelines
should be followed for Open edX code in general.

PR description template can be found at
`PR_TEMPLATE.md <https://github.com/edx/edx-celeryutils/blob/master/PR_TEMPLATE.md>`_

Reporting Security Issues
-------------------------

Please do not report security issues in public. Please email security@edx.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
~~~~~~~~~~


Added
_____
[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.


