123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165 |
- Metadata-Version: 1.1
- Name: flower
- Version: 0.7.3
- Summary: Celery Flower
- Home-page: https://github.com/mher/flower
- Author: Mher Movsisyan
- Author-email: mher.movsisyan@gmail.com
- License: BSD
- Description: Celery Flower
- =============
-
- .. image:: https://badge.fury.io/py/flower.png
- :target: http://badge.fury.io/py/flower
- .. image:: https://travis-ci.org/mher/flower.png?branch=master
- :target: https://travis-ci.org/mher/flower
- .. image:: https://pypip.in/d/flower/badge.png
- :target: https://crate.io/packages/flower/
-
- Flower is a web based tool for monitoring and administrating Celery clusters.
-
- Features
- --------
-
- - Real-time monitoring using Celery Events
-
- - Task progress and history
- - Ability to show task details (arguments, start time, runtime, and more)
- - Graphs and statistics
-
- - 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
- - Configuration viewer
- - Revoke or terminate tasks
-
- - Broker monitoring
-
- - View statistics for all Celery queues
- - Queue length graphs
-
- - HTTP API
- - Basic Auth and Google OpenID authentication
-
- API
- ---
-
- Flower API enables to manage the cluster via REST API, call tasks and
- receive task events in real-time via WebSockets.
-
- 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
-
- Or receive task completion events in real-time: ::
-
- var ws = new WebSocket('ws://localhost:5555/api/task/events/task-succeeded/');
- ws.onmessage = function (event) {
- console.log(event.data);
- }
-
- For more info checkout `API Reference`_ and `examples`_.
-
- .. _API Reference: http://flower.readthedocs.org/en/latest/api.html
- .. _examples: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb
-
- Installation
- ------------
-
- To install, simply: ::
-
- $ pip install flower
-
- Usage
- -----
-
- Launch the server and open http://localhost:5555: ::
-
- $ flower --port=5555
-
- Or launch from celery: ::
-
- $ celery flower -A proj --address=127.0.0.1 --port=5555
-
- Broker URL and other configuration options can be passed through the standard Celery options: ::
-
- $ celery flower -A proj --broker=amqp://guest:guest@localhost:5672//
-
- Documentation
- -------------
-
- Documentation is available at `Read the Docs`_ and `IPython Notebook Viewer`_
-
- .. _Read the Docs: http://flower.readthedocs.org
- .. _IPython Notebook Viewer: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb
-
- Screenshots
- -----------
-
- .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/dashboard.png
- :width: 100%
-
- .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/pool.png
- :width: 100%
-
- .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/tasks.png
- :width: 100%
-
- .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/task.png
- :width: 100%
-
- .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/monitor.png
- :width: 100%
-
- More screenshots_
-
- .. _screenshots: https://github.com/mher/flower/tree/master/docs/screenshots
-
- Getting help
- ------------
-
- Please head over to #celery IRC channel on irc.freenode.net or
- `open an issue`_.
-
- .. _open an issue: https://github.com/mher/flower/issues
-
- Contributing
- ------------
-
- If you'd like to contribute, simply fork `the repository`_, commit your
- changes, run the tests (`python -m tests`) and send a pull request.
- Make sure you add yourself to AUTHORS_.
-
- .. _`the repository`: https://github.com/mher/flower
- .. _AUTHORS: https://github.com/mher/flower/blob/master/AUTHORS
-
- Platform: UNKNOWN
- Classifier: Development Status :: 4 - Beta
- Classifier: Intended Audience :: Developers
- Classifier: License :: OSI Approved :: BSD License
- Classifier: Topic :: System :: Distributed Computing
- Classifier: Programming Language :: Python
- Classifier: Programming Language :: Python :: 2
- Classifier: Programming Language :: Python :: 2.6
- Classifier: Programming Language :: Python :: 2.7
- Classifier: Programming Language :: Python :: 3
- Classifier: Programming Language :: Python :: 3.2
- Classifier: Programming Language :: Python :: 3.3
- Classifier: Programming Language :: Python :: 3.4
- Classifier: Programming Language :: Python :: Implementation :: CPython
- Classifier: Operating System :: OS Independent
|