| Name | celery-starter JSON |
| Version |
1.0.8
JSON |
| download |
| home_page | https://github.com/Friskes/celery-starter |
| Summary | Django command to launch celery worker, beat, flower |
| upload_time | 2024-07-07 09:38:13 |
| maintainer | None |
| docs_url | None |
| author | Friskes |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Friskes 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 |
django
celery
beat
flower
autoreload
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Django command to run `celery (worker, beat, flower)` with automatically reboot server after changing files
<div align="center">
| Project | | Status |
|-----------|:----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CI/CD | | [](https://github.com/Friskes/celery-starter/actions/workflows/publish-to-pypi.yml) |
| Quality | | [](https://codecov.io/github/Friskes/celery-starter) |
| Package | | [](https://badge.fury.io/py/celery-starter)   |
| Meta | | [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/astral-sh/ruff) |
</div>
## Benefits of using this cli
> 1. The ability to run up to three servers (worker, beat, flower) simultaneously in one terminal, instead of running by default in three different terminals.
> 2. Automatic reboot of these servers when your codebase changes
## Install
1. Install package
```bash
pip install celery-starter
```
2. Add app name to `INSTALLED_APPS`
```python
INSTALLED_APPS = [
'celery_starter',
]
```
### Command to run the program:
```
python manage.py runcelery
```
Arguments can be passed in any order, it doesn't matter.
### Optional Arguments:
`-h` or `--help` Show help message.<br/>
`-w <cmd>` or `--worker <cmd>` Full command line to run worker or options that extend the default command line.<br/>
`-b <cmd>` or `--beat <cmd>` Full command line to run beat or options that extend the default command line.<br/>
`-f <cmd>` or `--flower <cmd>` Full command line to run flower or options that extend the default command line.<br/>
`-eb` or `--exclude_beat` Excludes the beat server at startup.<br/>
`-ef` or `--exclude_flower` Excludes the flower server at startup.<br/>
`-d` or `--debug` Displays information about successful/unsuccessful completion of processes.<br/>
#### To stopped program pressing the keyboard shortcut `CTRL+C`
### Examples of Commands
> default commands:
```shell
# worker cmd
# (WARNING) Note that the default pool is solo, because of this, all tasks will be performed sequentially, to get parallelism, install one of the libraries [gevent | eventlet] and redefine the default pool in cmd.
celery -A <CELERY_APP> worker -E -l INFO -P solo
# beat cmd
celery -A <CELERY_APP> beat --pidfile=celerybeat.pid -l INFO
# flower cmd
celery --broker=redis://localhost:6379// flower -A <CELERY_APP> --url_prefix=flower
```
> valid commands:
```shell
# redefining the -A and -P parameter and adding a new --broker parameter to the default worker command
python manage.py runcelery -w "-A <CELERY_APP> -P gevent --broker=redis://localhost:6379//"
# complete replacement of the default worker command with the passed command
python manage.py runcelery -w "celery -A <CELERY_APP> worker"
```
#### Working with beat and flower commands works in a similar way.
Raw data
{
"_id": null,
"home_page": "https://github.com/Friskes/celery-starter",
"name": "celery-starter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Django, Celery, Beat, Flower, Autoreload",
"author": "Friskes",
"author_email": "Friskes <friskesx@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/82/8f/448f24ba9e14c931c9ac2187c186f98095f471812a5accbdcded47496285/celery_starter-1.0.8.tar.gz",
"platform": null,
"description": "## Django command to run `celery (worker, beat, flower)` with automatically reboot server after changing files\n\n<div align=\"center\">\n\n| Project | | Status |\n|-----------|:----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| CI/CD | | [](https://github.com/Friskes/celery-starter/actions/workflows/publish-to-pypi.yml) |\n| Quality | | [](https://codecov.io/github/Friskes/celery-starter) |\n| Package | | [](https://badge.fury.io/py/celery-starter)   |\n| Meta | | [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/astral-sh/ruff) |\n\n</div>\n\n## Benefits of using this cli\n> 1. The ability to run up to three servers (worker, beat, flower) simultaneously in one terminal, instead of running by default in three different terminals.\n> 2. Automatic reboot of these servers when your codebase changes\n\n## Install\n1. Install package\n ```bash\n pip install celery-starter\n ```\n\n2. Add app name to `INSTALLED_APPS`\n ```python\n INSTALLED_APPS = [\n 'celery_starter',\n ]\n ```\n\n### Command to run the program:\n```\npython manage.py runcelery\n```\n\nArguments can be passed in any order, it doesn't matter.\n\n### Optional Arguments:\n`-h` or `--help` Show help message.<br/>\n`-w <cmd>` or `--worker <cmd>` Full command line to run worker or options that extend the default command line.<br/>\n`-b <cmd>` or `--beat <cmd>` Full command line to run beat or options that extend the default command line.<br/>\n`-f <cmd>` or `--flower <cmd>` Full command line to run flower or options that extend the default command line.<br/>\n`-eb` or `--exclude_beat` Excludes the beat server at startup.<br/>\n`-ef` or `--exclude_flower` Excludes the flower server at startup.<br/>\n`-d` or `--debug` Displays information about successful/unsuccessful completion of processes.<br/>\n\n#### To stopped program pressing the keyboard shortcut `CTRL+C`\n\n### Examples of Commands\n> default commands:\n\n```shell\n# worker cmd\n# (WARNING) Note that the default pool is solo, because of this, all tasks will be performed sequentially, to get parallelism, install one of the libraries [gevent | eventlet] and redefine the default pool in cmd.\ncelery -A <CELERY_APP> worker -E -l INFO -P solo\n\n# beat cmd\ncelery -A <CELERY_APP> beat --pidfile=celerybeat.pid -l INFO\n\n# flower cmd\ncelery --broker=redis://localhost:6379// flower -A <CELERY_APP> --url_prefix=flower\n```\n\n> valid commands:\n```shell\n# redefining the -A and -P parameter and adding a new --broker parameter to the default worker command\npython manage.py runcelery -w \"-A <CELERY_APP> -P gevent --broker=redis://localhost:6379//\"\n\n# complete replacement of the default worker command with the passed command\npython manage.py runcelery -w \"celery -A <CELERY_APP> worker\"\n```\n\n#### Working with beat and flower commands works in a similar way.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Friskes 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": "Django command to launch celery worker, beat, flower",
"version": "1.0.8",
"project_urls": {
"Changelog": "https://github.com/Friskes/celery-starter/releases/",
"Homepage": "https://github.com/Friskes/celery-starter",
"Issues": "https://github.com/Friskes/celery-starter/issues"
},
"split_keywords": [
"django",
" celery",
" beat",
" flower",
" autoreload"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78f7a833f42c2df44d484edbfd7d4f9669fcb5a2e5d03d10ef83605c3e266d95",
"md5": "b3ecb19e8abe4b68713111763371faaa",
"sha256": "3cad6ec234daa3f3536a36c4e20cb523b01366d36983515f2f73c167126427fb"
},
"downloads": -1,
"filename": "celery_starter-1.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3ecb19e8abe4b68713111763371faaa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10269,
"upload_time": "2024-07-07T09:38:12",
"upload_time_iso_8601": "2024-07-07T09:38:12.461791Z",
"url": "https://files.pythonhosted.org/packages/78/f7/a833f42c2df44d484edbfd7d4f9669fcb5a2e5d03d10ef83605c3e266d95/celery_starter-1.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "828f448f24ba9e14c931c9ac2187c186f98095f471812a5accbdcded47496285",
"md5": "61b3bfc0afd760f78547dc62080e9e0f",
"sha256": "cb23e7535aaa58a4fefe162aa36576d059bc517811a8e5eeecc6eee5ddc9ef42"
},
"downloads": -1,
"filename": "celery_starter-1.0.8.tar.gz",
"has_sig": false,
"md5_digest": "61b3bfc0afd760f78547dc62080e9e0f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20384,
"upload_time": "2024-07-07T09:38:13",
"upload_time_iso_8601": "2024-07-07T09:38:13.988767Z",
"url": "https://files.pythonhosted.org/packages/82/8f/448f24ba9e14c931c9ac2187c186f98095f471812a5accbdcded47496285/celery_starter-1.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-07 09:38:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Friskes",
"github_project": "celery-starter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "celery-starter"
}
