PKG-INFO 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. Metadata-Version: 1.1
  2. Name: flower
  3. Version: 0.7.3
  4. Summary: Celery Flower
  5. Home-page: https://github.com/mher/flower
  6. Author: Mher Movsisyan
  7. Author-email: mher.movsisyan@gmail.com
  8. License: BSD
  9. Description: Celery Flower
  10. =============
  11. .. image:: https://badge.fury.io/py/flower.png
  12. :target: http://badge.fury.io/py/flower
  13. .. image:: https://travis-ci.org/mher/flower.png?branch=master
  14. :target: https://travis-ci.org/mher/flower
  15. .. image:: https://pypip.in/d/flower/badge.png
  16. :target: https://crate.io/packages/flower/
  17. Flower is a web based tool for monitoring and administrating Celery clusters.
  18. Features
  19. --------
  20. - Real-time monitoring using Celery Events
  21. - Task progress and history
  22. - Ability to show task details (arguments, start time, runtime, and more)
  23. - Graphs and statistics
  24. - Remote Control
  25. - View worker status and statistics
  26. - Shutdown and restart worker instances
  27. - Control worker pool size and autoscale settings
  28. - View and modify the queues a worker instance consumes from
  29. - View currently running tasks
  30. - View scheduled tasks (ETA/countdown)
  31. - View reserved and revoked tasks
  32. - Apply time and rate limits
  33. - Configuration viewer
  34. - Revoke or terminate tasks
  35. - Broker monitoring
  36. - View statistics for all Celery queues
  37. - Queue length graphs
  38. - HTTP API
  39. - Basic Auth and Google OpenID authentication
  40. API
  41. ---
  42. Flower API enables to manage the cluster via REST API, call tasks and
  43. receive task events in real-time via WebSockets.
  44. For example you can restart worker's pool by: ::
  45. $ curl -X POST http://localhost:5555/api/worker/pool/restart/myworker
  46. Or call a task by: ::
  47. $ curl -X POST -d '{"args":[1,2]}' http://localhost:5555/api/task/async-apply/tasks.add
  48. Or terminate executing task by: ::
  49. $ curl -X POST -d 'terminate=True' http://localhost:5555/api/task/revoke/8a4da87b-e12b-4547-b89a-e92e4d1f8efd
  50. Or receive task completion events in real-time: ::
  51. var ws = new WebSocket('ws://localhost:5555/api/task/events/task-succeeded/');
  52. ws.onmessage = function (event) {
  53. console.log(event.data);
  54. }
  55. For more info checkout `API Reference`_ and `examples`_.
  56. .. _API Reference: http://flower.readthedocs.org/en/latest/api.html
  57. .. _examples: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb
  58. Installation
  59. ------------
  60. To install, simply: ::
  61. $ pip install flower
  62. Usage
  63. -----
  64. Launch the server and open http://localhost:5555: ::
  65. $ flower --port=5555
  66. Or launch from celery: ::
  67. $ celery flower -A proj --address=127.0.0.1 --port=5555
  68. Broker URL and other configuration options can be passed through the standard Celery options: ::
  69. $ celery flower -A proj --broker=amqp://guest:guest@localhost:5672//
  70. Documentation
  71. -------------
  72. Documentation is available at `Read the Docs`_ and `IPython Notebook Viewer`_
  73. .. _Read the Docs: http://flower.readthedocs.org
  74. .. _IPython Notebook Viewer: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb
  75. Screenshots
  76. -----------
  77. .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/dashboard.png
  78. :width: 100%
  79. .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/pool.png
  80. :width: 100%
  81. .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/tasks.png
  82. :width: 100%
  83. .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/task.png
  84. :width: 100%
  85. .. image:: https://raw.github.com/mher/flower/master/docs/screenshots/monitor.png
  86. :width: 100%
  87. More screenshots_
  88. .. _screenshots: https://github.com/mher/flower/tree/master/docs/screenshots
  89. Getting help
  90. ------------
  91. Please head over to #celery IRC channel on irc.freenode.net or
  92. `open an issue`_.
  93. .. _open an issue: https://github.com/mher/flower/issues
  94. Contributing
  95. ------------
  96. If you'd like to contribute, simply fork `the repository`_, commit your
  97. changes, run the tests (`python -m tests`) and send a pull request.
  98. Make sure you add yourself to AUTHORS_.
  99. .. _`the repository`: https://github.com/mher/flower
  100. .. _AUTHORS: https://github.com/mher/flower/blob/master/AUTHORS
  101. Platform: UNKNOWN
  102. Classifier: Development Status :: 4 - Beta
  103. Classifier: Intended Audience :: Developers
  104. Classifier: License :: OSI Approved :: BSD License
  105. Classifier: Topic :: System :: Distributed Computing
  106. Classifier: Programming Language :: Python
  107. Classifier: Programming Language :: Python :: 2
  108. Classifier: Programming Language :: Python :: 2.6
  109. Classifier: Programming Language :: Python :: 2.7
  110. Classifier: Programming Language :: Python :: 3
  111. Classifier: Programming Language :: Python :: 3.2
  112. Classifier: Programming Language :: Python :: 3.3
  113. Classifier: Programming Language :: Python :: 3.4
  114. Classifier: Programming Language :: Python :: Implementation :: CPython
  115. Classifier: Operating System :: OS Independent