The IM Squonk2 Deck (Squeck)
Project description
Squeck (Squonk2 Deck) is s Textual-UI (TUI) for the summary visualisation of multiple Squonk2 environments.
Squeck uses the squonk2-python-client to create a Deck displaying summary information for multiple Squonk2 environments and uses Will McGugan’s textual framework to provide the user with a simple, text-based user interface modelled on the popular k9s Kubernetes monitor.
Installation
Squeck is a Python application, written with Python 3.10 and published to PyPI and is easily installed using pip:
pip install im-squeck
Execution
Before running Squeck you must have access to at least one Squonk2 environment. Squeck obtains details of the environment through a YAML-based environments file. An example file, environments, is located in the root of this project:
When Squeck starts it will look for the environments file in your home directory, in the file ~/.squonk2/environments. If you place your populated environments file there you need do nothing else prior to running Squeck. If you prefer to put your environments file elsewhere, or have multiple files, set the path to your file using the environment variable SQUONK2_ENVIRONMENTS_FILE:
export SQUONK2_ENVIRONMENTS_FILE=~/my-squonk2-environments
With an environments file in place you can run Squeck:
squeck
Logging
You can enable logging from Squeck and the underlying textual framework by setting the environment variable SQUONK2_LOGFILE when running the application:
SQUONK2_LOGFILE=./squeck.log squeck
Debugging
Textual doesn’t like anything being written to the console so printing (even to stderr) will topple the display. That’s why stderr is diverted when the application is running and nothing is printed. There comes a time, though, when you need to see the error log. For these times you can run Squeck without stderr diverted:
squeck --enable-stderr
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for im_squeck-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcc6f3cca0a04c8ca605330b7e4a956046bec6c17c0017637e4c1cc7c300fcf8 |
|
MD5 | ad9017b6feec0f477acd1d7139e3aeb9 |
|
BLAKE2b-256 | 1d2ea898aec2a982436bf8f60397d461fd62a1a34e3354415f4117fbc59003f2 |