Flower
======
.. image:: https://img.shields.io/pypi/dm/flower.svg
:target: https://pypistats.org/packages/flower
:alt: PyPI - Downloads
.. image:: https://img.shields.io/docker/pulls/mher/flower.svg
:target: https://hub.docker.com/r/mher/flower
:alt: Docker Pulls
.. image:: https://github.com/mher/flower/workflows/Build/badge.svg
:target: https://github.com/mher/flower/actions
.. image:: https://img.shields.io/pypi/v/flower.svg
:target: https://pypi.python.org/pypi/flower
Flower is an open-source web application for monitoring and managing Celery clusters.
It provides real-time information about the status of Celery workers and tasks.
Features
--------
- Real-time monitoring using Celery Events
- View task progress and history
- View task details (arguments, start time, runtime, and more)
- Remote Control
- View worker status and statistics
- Shutdown and restart worker instances
- Control worker pool size and autoscale settings
- View and modify the queues a worker instance consumes from
- View currently running tasks
- View scheduled tasks (ETA/countdown)
- View reserved and revoked tasks
- Apply time and rate limits
- Revoke or terminate tasks
- Broker monitoring
- View statistics for all Celery queues
- HTTP Basic Auth, Google, Github, Gitlab and Okta OAuth
- Prometheus integration
- API
Installation
------------
Installing `flower` with `pip <http://www.pip-installer.org/>`_ is simple ::
$ pip install flower
The development version can be installed from Github ::
$ pip install https://github.com/mher/flower/zipball/master#egg=flower
Usage
-----
To run Flower, you need to provide the broker URL ::
$ celery --broker=amqp://guest:guest@localhost:5672// flower
Or use the configuration of `celery application <https://docs.celeryq.dev/en/stable/userguide/application.html>`_ ::
$ celery -A tasks.app flower
By default, flower runs on port 5555, which can be modified with the `port` option ::
$ celery -A tasks.app flower --port=5001
You can also run Flower using the docker image ::
$ docker run -v examples:/data -p 5555:5555 mher/flower celery --app=tasks.app flower
In this example, Flower is using the `tasks.app` defined in the `examples/tasks.py <https://github.com/mher/flower/blob/master/examples/tasks.py>`_ file
API
---
Flower API enables to manage the cluster via HTTP `REST API`.
For example you can restart worker's pool by: ::
$ curl -X POST http://localhost:5555/api/worker/pool/restart/myworker
Or call a task by: ::
$ curl -X POST -d '{"args":[1,2]}' http://localhost:5555/api/task/async-apply/tasks.add
Or terminate executing task by: ::
$ curl -X POST -d 'terminate=True' http://localhost:5555/api/task/revoke/8a4da87b-e12b-4547-b89a-e92e4d1f8efd
For more info checkout `API Reference`_
.. _API Reference: https://flower.readthedocs.io/en/latest/api.html
Documentation
-------------
Documentation is available at `Read the Docs`_
.. _Read the Docs: https://flower.readthedocs.io
License
-------
Flower is licensed under BSD 3-Clause License.
See the `License`_ file for the full license text.
.. _`License`: https://github.com/mher/flower/blob/master/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/mher/flower",
"name": "flower",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Mher Movsisyan",
"author_email": "mher.movsisyan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/09/a1/357f1b5d8946deafdcfdd604f51baae9de10aafa2908d0b7322597155f92/flower-2.0.1.tar.gz",
"platform": null,
"description": "Flower\n======\n\n.. image:: https://img.shields.io/pypi/dm/flower.svg\n :target: https://pypistats.org/packages/flower\n :alt: PyPI - Downloads\n.. image:: https://img.shields.io/docker/pulls/mher/flower.svg\n :target: https://hub.docker.com/r/mher/flower\n :alt: Docker Pulls\n.. image:: https://github.com/mher/flower/workflows/Build/badge.svg\n :target: https://github.com/mher/flower/actions\n.. image:: https://img.shields.io/pypi/v/flower.svg\n :target: https://pypi.python.org/pypi/flower\n\nFlower is an open-source web application for monitoring and managing Celery clusters.\nIt provides real-time information about the status of Celery workers and tasks.\n\nFeatures\n--------\n\n- Real-time monitoring using Celery Events\n - View task progress and history\n - View task details (arguments, start time, runtime, and more)\n- Remote Control\n - View worker status and statistics\n - Shutdown and restart worker instances\n - Control worker pool size and autoscale settings\n - View and modify the queues a worker instance consumes from\n - View currently running tasks\n - View scheduled tasks (ETA/countdown)\n - View reserved and revoked tasks\n - Apply time and rate limits\n - Revoke or terminate tasks\n- Broker monitoring\n - View statistics for all Celery queues\n- HTTP Basic Auth, Google, Github, Gitlab and Okta OAuth\n- Prometheus integration\n- API\n\nInstallation\n------------\n\nInstalling `flower` with `pip <http://www.pip-installer.org/>`_ is simple ::\n\n $ pip install flower\n\nThe development version can be installed from Github ::\n\n $ pip install https://github.com/mher/flower/zipball/master#egg=flower\n\nUsage\n-----\n\nTo run Flower, you need to provide the broker URL ::\n\n $ celery --broker=amqp://guest:guest@localhost:5672// flower\n\nOr use the configuration of `celery application <https://docs.celeryq.dev/en/stable/userguide/application.html>`_ ::\n\n $ celery -A tasks.app flower\n\nBy default, flower runs on port 5555, which can be modified with the `port` option ::\n\n $ celery -A tasks.app flower --port=5001\n\nYou can also run Flower using the docker image ::\n\n $ docker run -v examples:/data -p 5555:5555 mher/flower celery --app=tasks.app flower\n\nIn this example, Flower is using the `tasks.app` defined in the `examples/tasks.py <https://github.com/mher/flower/blob/master/examples/tasks.py>`_ file\n\nAPI\n---\n\nFlower API enables to manage the cluster via HTTP `REST API`.\n\nFor example you can restart worker's pool by: ::\n\n $ curl -X POST http://localhost:5555/api/worker/pool/restart/myworker\n\nOr call a task by: ::\n\n $ curl -X POST -d '{\"args\":[1,2]}' http://localhost:5555/api/task/async-apply/tasks.add\n\nOr terminate executing task by: ::\n\n $ curl -X POST -d 'terminate=True' http://localhost:5555/api/task/revoke/8a4da87b-e12b-4547-b89a-e92e4d1f8efd\n\nFor more info checkout `API Reference`_\n\n.. _API Reference: https://flower.readthedocs.io/en/latest/api.html\n\nDocumentation\n-------------\n\nDocumentation is available at `Read the Docs`_\n\n.. _Read the Docs: https://flower.readthedocs.io\n\nLicense\n-------\n\nFlower is licensed under BSD 3-Clause License.\nSee the `License`_ file for the full license text.\n\n.. _`License`: https://github.com/mher/flower/blob/master/LICENSE\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Celery Flower",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://github.com/mher/flower"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a6ffee2f67c0ff146ec98b5df1df637b2bc2d17beeb05df9f427a67bd7a7d79c",
"md5": "2fbd679052b323958483e5f96766c740",
"sha256": "9db2c621eeefbc844c8dd88be64aef61e84e2deb29b271e02ab2b5b9f01068e2"
},
"downloads": -1,
"filename": "flower-2.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fbd679052b323958483e5f96766c740",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 383553,
"upload_time": "2023-08-13T14:37:41",
"upload_time_iso_8601": "2023-08-13T14:37:41.552538Z",
"url": "https://files.pythonhosted.org/packages/a6/ff/ee2f67c0ff146ec98b5df1df637b2bc2d17beeb05df9f427a67bd7a7d79c/flower-2.0.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "09a1357f1b5d8946deafdcfdd604f51baae9de10aafa2908d0b7322597155f92",
"md5": "8d2d5ee71d191804b9125565f7d947a2",
"sha256": "5ab717b979530770c16afb48b50d2a98d23c3e9fe39851dcf6bc4d01845a02a0"
},
"downloads": -1,
"filename": "flower-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8d2d5ee71d191804b9125565f7d947a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3220408,
"upload_time": "2023-08-13T14:37:46",
"upload_time_iso_8601": "2023-08-13T14:37:46.073043Z",
"url": "https://files.pythonhosted.org/packages/09/a1/357f1b5d8946deafdcfdd604f51baae9de10aafa2908d0b7322597155f92/flower-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-13 14:37:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mher",
"github_project": "flower",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "flower"
}
JSON
