| Name | vcelery-task-runner JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | UI to allow interactively starting Celery tasks |
| upload_time | 2024-12-04 01:46:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2022 Van Ly Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
celery
python
django
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
amqp
annotated-types
asgiref
backports.tarfile
backports.zoneinfo
billiard
build
celery
certifi
cffi
charset-normalizer
click
click-didyoumean
click-plugins
click-repl
cryptography
Django
djangorestframework
docutils
idna
importlib_metadata
importlib_resources
jaraco.classes
jaraco.context
jaraco.functools
jeepney
keyring
kombu
markdown-it-py
mdurl
more-itertools
msgpack
nh3
packaging
pkginfo
prompt_toolkit
pycparser
pydantic
pydantic_core
Pygments
pyproject_hooks
python-dateutil
PyYAML
readme_renderer
requests
requests-toolbelt
rfc3986
rich
SecretStorage
six
sqlparse
tomli
twine
typing_extensions
tzdata
urllib3
vine
wcwidth
zipp
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Van's Celery Task Runner
This set of tools will present a UI to:
- search Celery tasks.
- start Celery tasks with parameters.
- Journaling of who ran what tasks.
## Autodiscovery of Runnable Tasks
<img width="915" alt="tasks_list" src="https://github.com/user-attachments/assets/9f3fa308-8b50-4412-a172-f813348107df">
## Task Running Form
<img width="1110" alt="task_run_form" src="https://github.com/user-attachments/assets/57c6c6f4-c72d-4c21-8a04-8975caa976c3">
Optional controls:
- Whitelisting task names to only surface a subset of the tasks
- Django permission control around who can see and run tasks
## Run Result
## Installation
- Install the package: `pip install vcelery-task-runner`
- Add into your project's `settings.py`:
```
INSTALLED_APPS = [
...
'rest_framework',
'vcelerytaskrunner.apps.AppConfig',
]
```
vcelery-task-runner uses the Django REST Library
- Run migration for the vcelerytaskrunner app:
```
python manage.py migrate vcelerytaskrunner
```
- In `settings.py`, let **vcelery-task-runner** know your Celery app:
```
# For example: from proj.celery import app as celery_app
from celery import Celery
from ... import app as celery_app
assert isinstance(celery_app, Celery)
# celery_app is a reference to your project's Celery app instance
VCELERY_TASKRUN_CELERY_APP = celery_app
```
- Optionally in `settings.py`, set the maximum age of run records to keep around (more about this [below](#taskrunrecords)).
```
VCELERY_TASK_RUN_RECORD_LONGEVITY = timedelta(weeks=52) # Or however long you want to keep records of task runs
```
## Configuration
### Runnable Tasks
#### VCELERY_TASKRUN_RUNNABLE_TASKS
By default, all tasks are "runnable" in the UI. However, if you wan to restrict
visibility to only a subset of the tasks, add into the project's `settings.py`:
```
VCELERY_TASKRUN_RUNNABLE_TASKS = {
"vcelerydev.tasks.say_hello", # full name of task
}
```
If you set up an empty set, NOTHING will be runnable (quick way to disable the run operation):
```
VCELERY_TASKRUN_RUNNABLE_TASKS = {
}
```
#### VCELERY_SHOW_ONLY_RUNNABLE_TASKS
Also by default, tasks not included in `VCELERY_TASKRUN_RUNNABLE_TASKS` will not be runnable but will be displayed in
the list of tasks. If that is undesired, set the `VCELERY_SHOW_ONLY_RUNNABLE_TASKS` to `True`:
If set, then only runnable tasks are shown in the UI:
```
# Tasks not in VCELERY_TASKRUN_RUNNABLE_TASKS will not be displayed in the task list
VCELERY_SHOW_ONLY_RUNNABLE_TASKS = True
```
### UI
There is a set of pages ready to list/search task by name and to run tasks. To add them
to you app, add these entries into your main `urls.py`:
```
from django.urls import path
...
from vcelerytaskrunner.views import TasksAPIView, TasksView, TaskRunFormView
...
urlpatterns = [
...
path('tasks/', TasksView.as_view(), name="vcelery-tasks"),
path('task_run/', TaskRunFormView.as_view(), name="vcelery-task-run"),
path('api/tasks/', TasksAPIView.as_view(), name="vcelery-api-tasks"),
....
]
```
The actual URL paths may vary according to your project's / app's needs. However, the names MUST be as shown because
there are code that look up the views by name (e.g. `django.urls.reverse("vcelery-task-run")`), and they will fail
if you don't use the names shown here.
The view classes obviously have to be the ones shown. Although if you looked at the code and have done so carefully,
you may derive from the views to specialize them as needed.
### Permissions
By default, only staff users have access to the UI. To add more users to the UI:
- Add the permission `vcelerytaskrunner.view_taskrunrecord` to allow a user to view the initial page (listing of tasks).
- Add ALSO the permission `vcelerytaskrunner.add_taskrunrecord` to allow a user to run a runnable task.
You are free to use groups to set this up.
## TaskRunRecords
Each run of a task through the UI is recorded into the model `vcelerytaskrunner.models.TaskRunRecord`:
### Pruning old records
Since each run is recorded, over time this table will grow large. Therefore, the `VCELERY_TASK_RUN_RECORD_LONGEVITY`
setting is used to define the longevity of these records.
Each time the **vcelerytaskrunner** app is initialized:
- a query is made to find `TaskRunRecord`s created before `datetime.utcnow() - VCELERY_TASK_RUN_RECORD_LONGEVITY`
- records older than this datetime **will be removed**.
If you don't explicitly define `VCELERY_TASK_RUN_RECORD_LONGEVITY` in your settings, the default value
`timedelta(weeks=4)` will be used, meaning entries older than 4 weeks will be removed.
#### Permanent records
If you want to keep TaskRunRecords forever (or clean them up manually), then set `VCELERY_TASK_RUN_RECORD_LONGEVITY` to
`"PERMANENT"`:
```
# Don't try to prune old TaskRunRecords
VCELERY_TASK_RUN_RECORD_LONGEVITY = "PERMANENT"
```
## TaskRunSignal
To be notified when a task is run, subscribe to the `TaskRunSignal` signal from `TaskRunner` from the module
`vcelerytaskrunner.services.task_runner`:
```
from vcelerytaskrunner.services.task_runner import TaskRunSignal, TaskRunner
...
@receiver(TaskRunSignal, sender=TaskRunner)
def task_run_listener(sender, **kwargs):
"""
Example of a signal handler for task run events.
"""
task_name = kwargs['task_name']
task_id = kwargs['task_id']
task_run_args = kwargs['args']
task_run_kwargs = kwargs['kwargs']
user = kwargs.get('user')
logger.info(
f"task_run_listener: task {task_name} (ID {task_id}) run by {user}"
f" with args={task_run_args}, kwargs={task_run_kwargs}"
)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "vcelery-task-runner",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "celery, python, django",
"author": null,
"author_email": "Van Ly <vancly@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c5/ef/a6bb7fb35a1934fbd5dd52d0bdd9bb198ad9934347d7c8166358d3ed8f1f/vcelery_task_runner-1.1.0.tar.gz",
"platform": null,
"description": "# Van's Celery Task Runner\n\nThis set of tools will present a UI to:\n- search Celery tasks.\n- start Celery tasks with parameters.\n- Journaling of who ran what tasks.\n\n## Autodiscovery of Runnable Tasks\n<img width=\"915\" alt=\"tasks_list\" src=\"https://github.com/user-attachments/assets/9f3fa308-8b50-4412-a172-f813348107df\">\n\n## Task Running Form\n<img width=\"1110\" alt=\"task_run_form\" src=\"https://github.com/user-attachments/assets/57c6c6f4-c72d-4c21-8a04-8975caa976c3\">\n\n\nOptional controls:\n\n- Whitelisting task names to only surface a subset of the tasks\n- Django permission control around who can see and run tasks\n\n## Run Result\n\n\n\n## Installation\n\n- Install the package: `pip install vcelery-task-runner`\n- Add into your project's `settings.py`:\n ```\n INSTALLED_APPS = [\n ...\n 'rest_framework',\n 'vcelerytaskrunner.apps.AppConfig',\n ]\n ```\n vcelery-task-runner uses the Django REST Library\n- Run migration for the vcelerytaskrunner app:\n ```\n python manage.py migrate vcelerytaskrunner\n ```\n- In `settings.py`, let **vcelery-task-runner** know your Celery app:\n ```\n # For example: from proj.celery import app as celery_app\n from celery import Celery\n \n from ... import app as celery_app\n \n assert isinstance(celery_app, Celery)\n \n # celery_app is a reference to your project's Celery app instance\n VCELERY_TASKRUN_CELERY_APP = celery_app\n ```\n- Optionally in `settings.py`, set the maximum age of run records to keep around (more about this [below](#taskrunrecords)).\n ```\n VCELERY_TASK_RUN_RECORD_LONGEVITY = timedelta(weeks=52) # Or however long you want to keep records of task runs\n ```\n\n## Configuration\n\n### Runnable Tasks\n\n#### VCELERY_TASKRUN_RUNNABLE_TASKS\nBy default, all tasks are \"runnable\" in the UI. However, if you wan to restrict\nvisibility to only a subset of the tasks, add into the project's `settings.py`:\n\n```\nVCELERY_TASKRUN_RUNNABLE_TASKS = {\n \"vcelerydev.tasks.say_hello\", # full name of task\n}\n```\n\nIf you set up an empty set, NOTHING will be runnable (quick way to disable the run operation):\n\n```\nVCELERY_TASKRUN_RUNNABLE_TASKS = {\n}\n```\n\n#### VCELERY_SHOW_ONLY_RUNNABLE_TASKS\nAlso by default, tasks not included in `VCELERY_TASKRUN_RUNNABLE_TASKS` will not be runnable but will be displayed in\nthe list of tasks. If that is undesired, set the `VCELERY_SHOW_ONLY_RUNNABLE_TASKS` to `True`:\n\nIf set, then only runnable tasks are shown in the UI:\n```\n# Tasks not in VCELERY_TASKRUN_RUNNABLE_TASKS will not be displayed in the task list\nVCELERY_SHOW_ONLY_RUNNABLE_TASKS = True\n```\n\n### UI\n\nThere is a set of pages ready to list/search task by name and to run tasks. To add them\nto you app, add these entries into your main `urls.py`:\n\n```\nfrom django.urls import path\n...\nfrom vcelerytaskrunner.views import TasksAPIView, TasksView, TaskRunFormView\n\n...\n\nurlpatterns = [\n ...\n path('tasks/', TasksView.as_view(), name=\"vcelery-tasks\"),\n path('task_run/', TaskRunFormView.as_view(), name=\"vcelery-task-run\"),\n\n path('api/tasks/', TasksAPIView.as_view(), name=\"vcelery-api-tasks\"),\n ....\n]\n```\n\nThe actual URL paths may vary according to your project's / app's needs. However, the names MUST be as shown because\nthere are code that look up the views by name (e.g. `django.urls.reverse(\"vcelery-task-run\")`), and they will fail \nif you don't use the names shown here.\n\nThe view classes obviously have to be the ones shown. Although if you looked at the code and have done so carefully,\nyou may derive from the views to specialize them as needed.\n\n\n### Permissions\n\nBy default, only staff users have access to the UI. To add more users to the UI:\n\n- Add the permission `vcelerytaskrunner.view_taskrunrecord` to allow a user to view the initial page (listing of tasks).\n- Add ALSO the permission `vcelerytaskrunner.add_taskrunrecord` to allow a user to run a runnable task.\n\nYou are free to use groups to set this up.\n\n## TaskRunRecords\n\nEach run of a task through the UI is recorded into the model `vcelerytaskrunner.models.TaskRunRecord`:\n\n\n\n\n\n\n\n### Pruning old records\n\nSince each run is recorded, over time this table will grow large. Therefore, the `VCELERY_TASK_RUN_RECORD_LONGEVITY`\nsetting is used to define the longevity of these records. \n\nEach time the **vcelerytaskrunner** app is initialized:\n- a query is made to find `TaskRunRecord`s created before `datetime.utcnow() - VCELERY_TASK_RUN_RECORD_LONGEVITY`\n- records older than this datetime **will be removed**.\n\nIf you don't explicitly define `VCELERY_TASK_RUN_RECORD_LONGEVITY` in your settings, the default value \n`timedelta(weeks=4)` will be used, meaning entries older than 4 weeks will be removed.\n\n#### Permanent records\n\nIf you want to keep TaskRunRecords forever (or clean them up manually), then set `VCELERY_TASK_RUN_RECORD_LONGEVITY` to \n`\"PERMANENT\"`:\n\n```\n# Don't try to prune old TaskRunRecords\nVCELERY_TASK_RUN_RECORD_LONGEVITY = \"PERMANENT\"\n```\n\n## TaskRunSignal\n\nTo be notified when a task is run, subscribe to the `TaskRunSignal` signal from `TaskRunner` from the module\n`vcelerytaskrunner.services.task_runner`:\n\n```\nfrom vcelerytaskrunner.services.task_runner import TaskRunSignal, TaskRunner\n\n...\n\n@receiver(TaskRunSignal, sender=TaskRunner)\ndef task_run_listener(sender, **kwargs):\n \"\"\"\n Example of a signal handler for task run events.\n \"\"\"\n task_name = kwargs['task_name']\n task_id = kwargs['task_id']\n task_run_args = kwargs['args']\n task_run_kwargs = kwargs['kwargs']\n user = kwargs.get('user')\n\n logger.info(\n f\"task_run_listener: task {task_name} (ID {task_id}) run by {user}\"\n f\" with args={task_run_args}, kwargs={task_run_kwargs}\"\n )\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Van Ly Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "UI to allow interactively starting Celery tasks",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/bluedenim/vcelery-task-runner"
},
"split_keywords": [
"celery",
" python",
" django"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53ab06f7b6fc21d67a9bf87fb7b74a83019c0b0e4f97dec7619f5c47070682e9",
"md5": "c626bddf4f33dd9362af7a4c36470808",
"sha256": "f8e692709f3d9f94143f7a985dc2a97d6e223027769e182b54c7a8c462ac08b0"
},
"downloads": -1,
"filename": "vcelery_task_runner-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c626bddf4f33dd9362af7a4c36470808",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 25411,
"upload_time": "2024-12-04T01:46:05",
"upload_time_iso_8601": "2024-12-04T01:46:05.146080Z",
"url": "https://files.pythonhosted.org/packages/53/ab/06f7b6fc21d67a9bf87fb7b74a83019c0b0e4f97dec7619f5c47070682e9/vcelery_task_runner-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c5efa6bb7fb35a1934fbd5dd52d0bdd9bb198ad9934347d7c8166358d3ed8f1f",
"md5": "df9f41f9ffb1824ea36143889387c428",
"sha256": "2c926559f4fe8dc9c9a22fb696a9bd94889010fd23e28071d6faa4087e7dddc3"
},
"downloads": -1,
"filename": "vcelery_task_runner-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "df9f41f9ffb1824ea36143889387c428",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20483,
"upload_time": "2024-12-04T01:46:06",
"upload_time_iso_8601": "2024-12-04T01:46:06.147135Z",
"url": "https://files.pythonhosted.org/packages/c5/ef/a6bb7fb35a1934fbd5dd52d0bdd9bb198ad9934347d7c8166358d3ed8f1f/vcelery_task_runner-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 01:46:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bluedenim",
"github_project": "vcelery-task-runner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "amqp",
"specs": [
[
"==",
"5.3.1"
]
]
},
{
"name": "annotated-types",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "asgiref",
"specs": [
[
"==",
"3.8.1"
]
]
},
{
"name": "backports.tarfile",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "backports.zoneinfo",
"specs": [
[
"==",
"0.2.1"
]
]
},
{
"name": "billiard",
"specs": [
[
"==",
"4.2.1"
]
]
},
{
"name": "build",
"specs": [
[
"==",
"1.2.2.post1"
]
]
},
{
"name": "celery",
"specs": [
[
"==",
"5.3.6"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.8.30"
]
]
},
{
"name": "cffi",
"specs": [
[
"==",
"1.17.1"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.4.0"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "click-didyoumean",
"specs": [
[
"==",
"0.3.1"
]
]
},
{
"name": "click-plugins",
"specs": [
[
"==",
"1.1.1"
]
]
},
{
"name": "click-repl",
"specs": [
[
"==",
"0.3.0"
]
]
},
{
"name": "cryptography",
"specs": [
[
"==",
"44.0.0"
]
]
},
{
"name": "Django",
"specs": [
[
"==",
"4.2.16"
]
]
},
{
"name": "djangorestframework",
"specs": [
[
"==",
"3.15.2"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.20.1"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.10"
]
]
},
{
"name": "importlib_metadata",
"specs": [
[
"==",
"8.5.0"
]
]
},
{
"name": "importlib_resources",
"specs": [
[
"==",
"6.4.5"
]
]
},
{
"name": "jaraco.classes",
"specs": [
[
"==",
"3.4.0"
]
]
},
{
"name": "jaraco.context",
"specs": [
[
"==",
"6.0.1"
]
]
},
{
"name": "jaraco.functools",
"specs": [
[
"==",
"4.1.0"
]
]
},
{
"name": "jeepney",
"specs": [
[
"==",
"0.8.0"
]
]
},
{
"name": "keyring",
"specs": [
[
"==",
"25.5.0"
]
]
},
{
"name": "kombu",
"specs": [
[
"==",
"5.4.2"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "more-itertools",
"specs": [
[
"==",
"10.5.0"
]
]
},
{
"name": "msgpack",
"specs": [
[
"==",
"1.0.7"
]
]
},
{
"name": "nh3",
"specs": [
[
"==",
"0.2.19"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.2"
]
]
},
{
"name": "pkginfo",
"specs": [
[
"==",
"1.12.0"
]
]
},
{
"name": "prompt_toolkit",
"specs": [
[
"==",
"3.0.48"
]
]
},
{
"name": "pycparser",
"specs": [
[
"==",
"2.22"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.10.1"
]
]
},
{
"name": "pydantic_core",
"specs": [
[
"==",
"2.27.1"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "pyproject_hooks",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.9.0.post0"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0.2"
]
]
},
{
"name": "readme_renderer",
"specs": [
[
"==",
"43.0"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "rfc3986",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"13.9.4"
]
]
},
{
"name": "SecretStorage",
"specs": [
[
"==",
"3.3.3"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "sqlparse",
"specs": [
[
"==",
"0.5.2"
]
]
},
{
"name": "tomli",
"specs": [
[
"==",
"2.2.1"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"6.0.1"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.12.2"
]
]
},
{
"name": "tzdata",
"specs": [
[
"==",
"2024.2"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.3"
]
]
},
{
"name": "vine",
"specs": [
[
"==",
"5.1.0"
]
]
},
{
"name": "wcwidth",
"specs": [
[
"==",
"0.2.13"
]
]
},
{
"name": "zipp",
"specs": [
[
"==",
"3.20.2"
]
]
}
],
"lcname": "vcelery-task-runner"
}
