File tree Expand file tree Collapse file tree 3 files changed +19
-11
lines changed Expand file tree Collapse file tree 3 files changed +19
-11
lines changed Original file line number Diff line number Diff line change @@ -25,24 +25,22 @@ edx-celeryutils
2525 :target: https://github.com/edx/edx-celeryutils/blob/master/LICENSE.txt
2626 :alt: License
2727
28- The ``README.rst `` file should start with a brief description of the repository,
29- which sets it in the context of other repositories under the ``edx ``
30- organization. It should make clear where this fits in to the overall edX
31- codebase.
32-
33- Code to support working with celery
28+ Code to support working with Celery, a distributed task queue.
3429
3530Overview (please modify)
3631------------------------
3732
38- The ``README.rst `` file should then provide an overview of the code in this
39- repository, including the main components and useful entry points for starting
40- to understand the code in more detail.
33+ This package contains utilities to wrap tasks with logging and to
34+ persist them if they fail.
35+
36+ It also supports Django administration for searching and deleting
37+ failed tasks, and management commands for rerunning failed tasks and
38+ deleting old ones.
4139
4240Documentation
4341-------------
4442
45- The full documentation is at https://edx-celeryutils.readthedocs.org.
43+ (TODO: ` Set up documentation < https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs >`_)
4644
4745Publishing a Release
4846--------------------
Original file line number Diff line number Diff line change 2424class FailedTask (TimeStampedModel ):
2525 """
2626 Representation of tasks that have failed.
27+
28+ .. pii::
29+ Stores arbitrary task parameters, which theoretically could include
30+ email addresses, although as of May 2020 does not seem to.
31+ Old tasks can be manually deleted in the Django administration UI.
32+ .. pii_retirement: local_api
33+ .. pii_types: other
2734 """
2835
2936 task_name = models .CharField (max_length = 255 )
Original file line number Diff line number Diff line change 11# openedx.yaml
22
33---
4- owner : edx/teaching-and-learning
4+ owner :
5+ type : team
6+ team : edx/arch-bom
57nick : edx-celeryutils
68tags :
79 - tools
1416 state : False
1517 reason : Not relevant to this app
1618 oep-7 : True
19+ oep-30 : True
You can’t perform that action at this time.
0 commit comments