multivisor 6.0.1__tar.gz → 6.0.2__tar.gz

multivisor-6.0.2/PKG-INFO

@@ -0,0 +1,375 @@
+Metadata-Version: 2.4
+Name: multivisor
+Version: 6.0.2
+Summary: A centralized supervisor UI (web & CLI)
+Author: Tiago Coutinho
+Author-email: coutinhotiago@gmail.com
+License: GNU General Public License v3
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+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.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: System :: Boot
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Systems Administration
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: six
+Requires-Dist: gevent>=1.3
+Provides-Extra: rpc
+Requires-Dist: zerorpc; extra == "rpc"
+Requires-Dist: supervisor; extra == "rpc"
+Provides-Extra: web
+Requires-Dist: flask; extra == "web"
+Requires-Dist: werkzeug; extra == "web"
+Requires-Dist: blinker; extra == "web"
+Requires-Dist: zerorpc; extra == "web"
+Requires-Dist: supervisor; extra == "web"
+Provides-Extra: cli
+Requires-Dist: maya; extra == "cli"
+Requires-Dist: requests; extra == "cli"
+Requires-Dist: prompt_toolkit>=2; extra == "cli"
+Requires-Dist: blinker; extra == "cli"
+Provides-Extra: all
+Requires-Dist: blinker; extra == "all"
+Requires-Dist: zerorpc; extra == "all"
+Requires-Dist: werkzeug; extra == "all"
+Requires-Dist: supervisor; extra == "all"
+Requires-Dist: prompt_toolkit>=2; extra == "all"
+Requires-Dist: maya; extra == "all"
+Requires-Dist: flask; extra == "all"
+Requires-Dist: requests; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+# Multivisor
+
+<img width="60%" align="right" alt="multivisor web on chrome desktop app"
+ title="multivisor web on chrome desktop app"
+ src="doc/multivisor_desktop.png"
+/>
+
+
+[![Multivisor][pypi-version]](https://pypi.python.org/pypi/multivisor)
+[![Python Versions][pypi-python-versions]](https://pypi.python.org/pypi/multivisor)
+[![Pypi status][pypi-status]](https://pypi.python.org/pypi/multivisor)
+![License][license]
+[![Build Status][build]](https://travis-ci.org/guy881/multivisor)
+
+A centralized supervisor UI (Web & CLI)
+
+* Processes status always up to date
+* Reactivity through asynchronous actions
+* Notifications when state changes
+* Mobile aware, SPA web page
+* Powerful filters
+* Interactive CLI
+* works on [supervisor](https://pypi.org/project/supervisor/)
+  and [supervisor-win](https://pypi.org/project/supervisor-win/)
+
+Multivisor is comprised of 3 components:
+
+1. **web server**: gathers information from all supervisors and provides a
+   dashboard like UI to the entire system
+1. **multivisor RPC**: an RPC extension to supervisor used to communicate
+   between each supervisord and multivisor web server
+1. **CLI**: an optional CLI which communicates with multivisor web server
+
+## Installation and configuration
+
+The installation and configuration steps are exactly the same on Linux and
+Windows.
+
+Thanks to the [ESRF](https://esrf.eu) sponsorship, multivisor is able to work
+well with [supervisor-win](https://pypi.org/project/supervisor-win/).
+
+### RPC
+
+The multivisor RPC must be installed in the same environment(s) as your
+supervisord instances. It can be installed on python environments ranging from
+2.7 to 3.x.
+
+From within the same python environment as your supervisord process, type:
+
+```bash
+pip install multivisor[rpc]
+```
+
+There are two options to configure multivisor RPC: 1) as an extra
+[rpcinterface](http://supervisord.org/configuration.html#rpcinterface-x-section-settings)
+to supervisord or 2) an [eventlistener](http://supervisord.org/configuration.html#eventlistener-x-section-settings) process managed by supervisord.
+
+The first option has the advantage of not requiring an extra process but it's
+implementation relies on internal supervisord details. Therefore, the multivisor
+author recommends using the 2nd approach.
+
+#### Option 1: rpcinterface
+
+Configure the multivisor rpc interface by adding the following lines
+to your *supervisord.conf*:
+
+```ini
+[rpcinterface:multivisor]
+supervisor.rpcinterface_factory = multivisor.rpc:make_rpc_interface
+bind=*:9002
+```
+
+If no *bind* is given, it defaults to `*:9002`.
+
+Repeat the above procedure for every supervisor you have running.
+
+#### Option 2: eventlistener
+
+Configure the multivisor rpc interface by adding the following lines
+to your *supervisord.conf*:
+
+```ini
+[eventlistener:multivisor-rpc]
+command=multivisor-rpc --bind 0:9002
+events=PROCESS_STATE,SUPERVISOR_STATE_CHANGE
+```
+
+If no *bind* is given, it defaults to `*:9002`.
+
+You are free to choose the event listener name. As a convention we propose
+`multivisor-rpc`.
+
+NB: Make sure that `multivisor-rpc` command is accessible or provide full PATH.
+
+Repeat the above procedure for every supervisor you have running.
+
+
+### Web server
+
+The multivisor web server requires a python 3.x environment. It must be
+installed on a machine with a network access to the different supervisors.
+This is achieved with:
+
+```bash
+pip install multivisor[web]
+```
+
+The web server is configured with a INI like configuration file
+(much like supervisor itself) that is passed as command line argument.
+It is usually named *multivisor.conf* but can be any filename you which.
+
+The file consists of a `global` section where you can give an optional name to
+your multivisor instance (default is *multivisor*. This name will appear on the
+top left corner of multivisor the web page).
+
+To add a new supervisor to the list simply add a section `[supervisor:<name>]`.
+It accepts an optional `url` in the format `[<host>][:<port>]`. The default
+is `<name>:9002`.
+
+Here is an example:
+
+```ini
+[global]
+name=ACME
+
+[supervisor:roadrunner]
+# since no url is given it will be roadrunner:9002
+
+[supervisor:coyote]
+# no host is given: defaults to coyote
+url=:9011
+
+[supervisor:bugsbunny]
+# no port is given: defaults to 9002
+url=bugsbunny.acme.org
+
+[supervisor:daffyduck]
+url=daffyduck.acme.org:9007
+```
+
+<img width="40%" align="right" alt="multivisor web on mobile"
+ title="multivisor web on mobile"
+ src="doc/multivisor_mobile.png"
+/>
+
+Once installed and configured, the web server can be started from the command
+line with:
+
+```bash
+multivisor -c ./multivisor.conf
+```
+
+Start a browser pointing to [localhost:22000](http://localhost:22000).
+On a mobile device it should look something like the figure on the right.
+
+Of course the multivisor web server itself can be configured in supervisor as a
+normal program.
+
+#### Authentication
+
+To protect multivisor from unwanted access, you can enable authentication.
+
+Specify `username` and `password` parameters in `global` section of your configuration file e.g.:
+
+```ini
+[global]
+username=test
+password=test
+```
+
+You can also specify `password` as SHA-1 hash in hex, with `{SHA}` prefix: e.g.
+`{SHA}a94a8fe5ccb19ba61c4c0873d391e987982fbbd3` (example hash is `test` in SHA-1).
+
+In order to use authentication, you also need to set `MULTIVISOR_SECRET_KEY` environmental variable,
+as flask sessions module needs some secret value to create secure session.
+You can generate some random hash easily using python:
+`python -c 'import os; import binascii; print(binascii.hexlify(os.urandom(32)))'`
+
+### CLI
+
+The multivisor CLI is an optional component which can be installed with:
+
+```bash
+pip install multivisor[cli]
+```
+
+The CLI connects directly to the web server using an HTTP REST API.
+It doesn't require any configuration.
+
+It can be started with:
+
+```bash
+multivisor-cli --url localhost:22000
+```
+
+![CLI in action](doc/cli.svg)
+
+# Running the docker demo
+
+```bash
+$ docker-compose build --parallel
+$ docker-compose up
+```
+
+That's it!
+
+Start a browser pointing to [localhost:22000](http://localhost:22000).
+
+# Running the example from scratch
+
+```bash
+# Fetch the project:
+git clone https://github.com/tiagocoutinho/multivisor
+cd multivisor
+
+
+# Install frontend dependencies
+npm install
+# Build for production with minification
+npm run build
+
+# feel free to use your favorite python virtual environment
+# here. Otherwise you will need administrative privileges
+pip install .[all]
+
+# Launch a few supervisors
+mkdir examples/full_example/log
+supervisord -c examples/full_example/supervisord_lid001.conf
+supervisord -c examples/full_example/supervisord_lid002.conf
+supervisord -c examples/full_example/supervisord_baslid001.conf
+
+# Finally, launch multivisor:
+multivisor -c examples/full_example/multivisor.conf
+```
+
+That's it!
+
+Start a browser pointing to [localhost:22000](http://localhost:22000). On a mobile
+device it should look something like this:
+
+![multivisor on mobile](doc/multivisor_mobile.png)
+
+# Technologies
+
+![multivisor diagram](doc/diagram.png)
+
+The `multivisor` backend runs a [flask](http://flask.pocoo.org/) web server.
+
+The `multivisor-cli` runs a
+[prompt-toolkit](http://python-prompt-toolkit.rtfd.io) based console.
+
+The frontend is based on [vue](https://vuejs.org/) +
+[vuex](https://vuex.vuejs.org/) + [vuetify](https://vuetifyjs.com/).
+
+# Development
+
+## Build & Install
+
+```bash
+
+# install frontend
+npm install
+
+# build for production with minification
+npm run build
+
+# install backend
+pip install -e .
+
+```
+
+## Run
+
+```bash
+# serve at localhost:22000
+multivisor -c multivisor.conf
+```
+
+Start a browser pointing to [localhost:22000](http://localhost:22000)
+
+## Development mode
+
+You can run the backend using the webpack dev server to facilitate your
+development cycle:
+
+First, start multivisor (which listens on 22000 by default):
+
+```bash
+python -m multivisor.server.web -c multivisor.conf
+```
+
+Now, in another console, run the webpack dev server (it will
+transfer the requests between the browser and multivisor):
+
+``` bash
+npm run dev
+```
+
+That's it. If you modify `App.vue` for example, you should see the changes
+directly on your browser.
+
+
+[pypi-python-versions]: https://img.shields.io/pypi/pyversions/multivisor.svg
+[pypi-version]: https://img.shields.io/pypi/v/multivisor.svg
+[pypi-status]: https://img.shields.io/pypi/status/multivisor.svg
+[license]: https://img.shields.io/pypi/l/multivisor.svg
+[build]: https://travis-ci.org/guy881/multivisor.svg?branch=develop

{multivisor-6.0.1 → multivisor-6.0.2}/README.md

@@ -195,6 +195,17 @@ multivisor-cli --url localhost:22000
 
 ![CLI in action](doc/cli.svg)
 
+# Running the docker demo
+
+```bash
+$ docker-compose build --parallel
+$ docker-compose up
+```
+
+That's it!
+
+Start a browser pointing to [localhost:22000](http://localhost:22000).
+
 # Running the example from scratch
 
 ```bash

{multivisor-6.0.1 → multivisor-6.0.2}/multivisor/multivisor.py

@@ -8,9 +8,9 @@ import weakref
 from blinker import signal
 
 try:
-    from ConfigParser import SafeConfigParser
+    from ConfigParser import SafeConfigParser as ConfigParser
 except ImportError:
-    from configparser import SafeConfigParser
+    from configparser import ConfigParser
 
 import zerorpc
 from gevent import spawn, sleep, joinall
@@ -332,7 +332,7 @@ class Process(dict):
 
 
 def load_config(config_file):
-    parser = SafeConfigParser()
+    parser = ConfigParser()
     parser.read(config_file)
     dft_global = dict(name="multivisor")