{"id":17005943,"url":"https://github.com/friskes/celery-starter","last_synced_at":"2025-03-22T16:30:53.317Z","repository":{"id":181277649,"uuid":"666027813","full_name":"Friskes/celery-starter","owner":"Friskes","description":"Django command to run celery (worker, beat, flower) with automatically reboot server after changing files","archived":false,"fork":false,"pushed_at":"2024-11-30T11:50:58.000Z","size":68,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-18T13:32:21.552Z","etag":null,"topics":["autoreload","celery","celery-beat","celery-flower","celery-worker","django","linux","python","windows"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Friskes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-13T14:37:06.000Z","updated_at":"2024-11-30T11:47:03.000Z","dependencies_parsed_at":"2024-10-28T14:07:41.319Z","dependency_job_id":"e7021758-7a97-4db9-969f-23161c2644ed","html_url":"https://github.com/Friskes/celery-starter","commit_stats":{"total_commits":23,"total_committers":1,"mean_commits":23.0,"dds":0.0,"last_synced_commit":"cb2e942c452458c81bf213053075dfb464744407"},"previous_names":["friskes/celery_starter","friskes/celery-starter"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Friskes%2Fcelery-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Friskes%2Fcelery-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Friskes%2Fcelery-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Friskes%2Fcelery-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Friskes","download_url":"https://codeload.github.com/Friskes/celery-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244986370,"owners_count":20543003,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autoreload","celery","celery-beat","celery-flower","celery-worker","django","linux","python","windows"],"created_at":"2024-10-14T05:04:34.150Z","updated_at":"2025-03-22T16:30:52.965Z","avatar_url":"https://github.com/Friskes.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Django command to run `celery (worker, beat, flower)` with automatically reboot server after changing files\n\n\u003cdiv align=\"center\"\u003e\n\n| Project   |     | Status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |\n|-----------|:----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| CI/CD     |     | [![Latest Release](https://github.com/Friskes/celery-starter/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/Friskes/celery-starter/actions/workflows/publish-to-pypi.yml)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |\n| Quality   |     | [![Coverage](https://codecov.io/github/Friskes/celery-starter/graph/badge.svg?token=vKez4Pycrc)](https://codecov.io/github/Friskes/celery-starter)                                                                                                                                                                                                                                                                                                                               |\n| Package   |     | [![PyPI - Version](https://img.shields.io/pypi/v/celery-starter?labelColor=202235\u0026color=edb641\u0026logo=python\u0026logoColor=edb641)](https://badge.fury.io/py/celery-starter) ![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/celery-starter?labelColor=202235\u0026color=edb641\u0026logo=python\u0026logoColor=edb641) ![Project PyPI - Downloads](https://img.shields.io/pypi/dm/celery-starter?logo=python\u0026label=downloads\u0026labelColor=202235\u0026color=edb641\u0026logoColor=edb641)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |\n| Meta      |     | [![types - Mypy](https://img.shields.io/badge/types-Mypy-202235.svg?logo=python\u0026labelColor=202235\u0026color=edb641\u0026logoColor=edb641)](https://github.com/python/mypy) [![License - MIT](https://img.shields.io/badge/license-MIT-202235.svg?logo=python\u0026labelColor=202235\u0026color=edb641\u0026logoColor=edb641)](https://spdx.org/licenses/) [![code style - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json\u0026labelColor=202235)](https://github.com/astral-sh/ruff) |\n\n\u003c/div\u003e\n\n## Benefits of using this cli\n\u003e 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\u003e 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.\u003cbr/\u003e\n`-w \u003ccmd\u003e` or `--worker \u003ccmd\u003e` Full command line to run worker or options that extend the default command line.\u003cbr/\u003e\n`-b \u003ccmd\u003e` or `--beat \u003ccmd\u003e` Full command line to run beat or options that extend the default command line.\u003cbr/\u003e\n`-f \u003ccmd\u003e` or `--flower \u003ccmd\u003e` Full command line to run flower or options that extend the default command line.\u003cbr/\u003e\n`-eb` or `--exclude_beat` Excludes the beat server at startup.\u003cbr/\u003e\n`-ef` or `--exclude_flower` Excludes the flower server at startup.\u003cbr/\u003e\n`-d` or `--debug` Displays information about successful/unsuccessful completion of processes.\u003cbr/\u003e\n\n#### To stopped program pressing the keyboard shortcut `CTRL+C`\n\n### Examples of Commands\n\u003e default commands:\n\n```shell\n# worker cmd\n# (WARNING) Note that the default pool is solo,\n# because of this, all tasks will be performed sequentially,\n# to get parallelism, install one of the libraries [gevent | eventlet]\n# and redefine the default pool in cmd.\ncelery -A \u003cCELERY_APP\u003e worker -E -l INFO -P solo\n\n# beat cmd\ncelery -A \u003cCELERY_APP\u003e beat --pidfile=celerybeat.pid -l INFO\n\n# flower cmd\ncelery --broker=redis://localhost:6379// flower -A \u003cCELERY_APP\u003e --url_prefix=flower\n```\n\n\u003e valid commands:\n```shell\n# redefining the -A and -P parameter\n# and adding a new --broker parameter to the default worker command\npython manage.py runcelery -w \"-A \u003cCELERY_APP\u003e -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 \u003cCELERY_APP\u003e worker\"\n```\n\n#### Working with beat and flower commands works in a similar way.\n\n## Contributing\nWe would love you to contribute to `celery-starter`, pull requests are very welcome! Please see [CONTRIBUTING.md](https://github.com/Friskes/celery-starter/blob/main/CONTRIBUTING.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriskes%2Fcelery-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffriskes%2Fcelery-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriskes%2Fcelery-starter/lists"}