Skip to content

johan-sports/wscelery

Repository files navigation

WS Celery

https://travis-ci.org/johan-sports/wscelery.svg?branch=master Documentation Status

Real time celery monitoring using websockets. Inspired by flower.

Requirements

  • Python >= 3.4

Installation

PyPI version (recommended):

$ pip install wscelery

Development version:

$ pip install https://github.com/johan-sports/wscelery/zipball/master

Usage

Launch the websocket listener on port 8001:

$ wscelery --port=8001

Or launch from celery:

$ celery wscelery -A proj --address=127.0.0.1 --port=8001

Broker URL and other configuration options can be passed through standard Celery options:

$ celery wscelery -A proj --broker=amqp://guest:guest@localhost:5672//

To see all command options use:

$ wscelery --help

Documentation

Full documentation can be found on Read The Docs.

Caveats

  • TLS encryption not (yet) supported

Contributing

If you want to contribute, feel free to submit a PR. Please make sure that the tests pass (run with python setup.py test). Make sure you add your name to CONTRIBUTORS.

License

Licensed under MIT. See the LICENSE file in the project root directory.