Metadata-Version: 1.1
Name: flower
Version: 0.9.5
Summary: Celery Flower
Home-page: https://github.com/mher/flower
Author: Mher Movsisyan
Author-email: mher.movsisyan@gmail.com
License: BSD
Description: Flower
        ======
        
        .. 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
        
        .. image:: https://travis-ci.org/mher/flower.svg?branch=master
                :target: https://travis-ci.org/mher/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, Google, Github, Gitlab and Okta OAuth
        - Prometheus integration
        
        Installation
        ------------
        
        PyPI version: ::
        
            $ pip install flower
        
        Development version: ::
        
            $ pip install https://github.com/mher/flower/zipball/master
        
        Usage
        -----
        
        Launch the server and open http://localhost:5555: ::
        
            $ flower --port=5555
        
        Launch from celery: ::
        
            $ celery flower -A proj --address=127.0.0.1 --port=5555
        
        Launch using docker: ::
        
            $ docker run -p 5555:5555 mher/flower
        
        Launch with unix socket file: ::
        
            $ flower --unix-socket=/tmp/flower.sock
        
        Broker URL and other configuration options can be passed through the standard Celery options: ::
        
            $ celery flower -A proj --broker=amqp://guest:guest@localhost:5672//
        
        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: https://flower.readthedocs.io/en/latest/api.html
        .. _examples: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb
        
        Documentation
        -------------
        
        Documentation is available at `Read the Docs`_ and `IPython Notebook Viewer`_
        
        .. _Read the Docs: https://flower.readthedocs.io
        .. _IPython Notebook Viewer: http://nbviewer.ipython.org/urls/raw.github.com/mher/flower/master/docs/api.ipynb
        
        License
        -------
        
        Flower is licensed under BSD 3-Clause License. See the LICENSE file
        in the top distribution directory for the full license text.
        
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.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Operating System :: OS Independent
