############
Squonk2 Deck
############
.. image:: https://img.shields.io/pypi/pyversions/im-squeck
:alt: PyPI - Python Version
.. image:: https://img.shields.io/pypi/v/im-squeck
:alt: PyPI
.. image:: https://img.shields.io/github/license/informaticsmatters/squonk2-deck
:alt: GitHub
.. image:: https://img.shields.io/github/actions/workflow/status/informaticsmatters/squonk2-deck/build.yaml?label=build%20workflow
:alt: GitHub Workflow Status
.. image:: https://img.shields.io/github/actions/workflow/status/informaticsmatters/squonk2-deck/publish.yaml?label=publish%20workflow
:alt: GitHub Workflow Status
**Squeck** (Squonk2 Deck) is s Textual-UI (TUI) for the
summary visualisation of multiple Squonk2 environments.
.. image:: docs/images/screenshot.png
**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.
It displays a summary of the environments, where: -
- A green tick indicates that the authenticator service has issued a token for the service
- The service version is displayed for those that are running
- A **NO RESPONSE** banner is displayed for services that are not responding
.. _k9s: https://k9scli.io
.. _squonk2-python-client: https://github.com/InformaticsMatters/squonk2-python-client
.. _textual: https://github.com/Textualize/textual
************
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
.. _pypi: https://pypi.org/project/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
Raw data
{
"_id": null,
"home_page": "https://github.com/informaticsmatters/squonk2-deck",
"name": "im-squeck",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "configuration",
"author": "Alan Christie",
"author_email": "achristie@informaticsmatters.com",
"download_url": "https://files.pythonhosted.org/packages/33/6b/f27569ad838e9feb489f058560d0190f66d3d3911ac8f023902d64b0a4b0/im-squeck-1.1.1.tar.gz",
"platform": "any",
"description": "############\nSquonk2 Deck\n############\n\n.. image:: https://img.shields.io/pypi/pyversions/im-squeck\n :alt: PyPI - Python Version\n.. image:: https://img.shields.io/pypi/v/im-squeck\n :alt: PyPI\n.. image:: https://img.shields.io/github/license/informaticsmatters/squonk2-deck\n :alt: GitHub\n.. image:: https://img.shields.io/github/actions/workflow/status/informaticsmatters/squonk2-deck/build.yaml?label=build%20workflow\n :alt: GitHub Workflow Status\n.. image:: https://img.shields.io/github/actions/workflow/status/informaticsmatters/squonk2-deck/publish.yaml?label=publish%20workflow\n :alt: GitHub Workflow Status\n\n**Squeck** (Squonk2 Deck) is s Textual-UI (TUI) for the\nsummary visualisation of multiple Squonk2 environments.\n\n.. image:: docs/images/screenshot.png\n\n**Squeck** uses the `squonk2-python-client`_ to create a **Deck** displaying\nsummary information for multiple Squonk2 environments and uses Will McGugan's\n`textual`_ framework to provide the user with a simple,\ntext-based user interface modelled on the popular `k9s`_ Kubernetes monitor.\n\nIt displays a summary of the environments, where: -\n\n- A green tick indicates that the authenticator service has issued a token for the service\n- The service version is displayed for those that are running\n- A **NO RESPONSE** banner is displayed for services that are not responding\n\n.. _k9s: https://k9scli.io\n.. _squonk2-python-client: https://github.com/InformaticsMatters/squonk2-python-client\n.. _textual: https://github.com/Textualize/textual\n\n************\nInstallation\n************\n\n**Squeck** is a Python application, written with Python 3.10 and published\nto `PyPI`_ and is easily installed using ``pip``::\n\n pip install im-squeck\n\n.. _pypi: https://pypi.org/project/im-squeck/\n\n*********\nExecution\n*********\n\nBefore running **Squeck** you must have access to at least one Squonk2 environment.\n**Squeck** obtains details of the environment through a YAML-based\n*environments* file. An example file, ``environments``, is located in the root\nof this project:\n\nWhen **Squeck** starts it will look for the environments file in your home\ndirectory, in the file ``~/.squonk2/environments``. If you place your populated\nenvironments file there you need do nothing else prior to running **Squeck**.\nIf you prefer to put your ``environments`` file elsewhere, or have multiple\nfiles, set the path to your file using the environment variable\n``SQUONK2_ENVIRONMENTS_FILE``::\n\n export SQUONK2_ENVIRONMENTS_FILE=~/my-squonk2-environments\n\nWith an environments file in place you can run **Squeck**::\n\n squeck\n\nLogging\n-------\n\nYou can enable logging from **Squeck** and the underlying textual framework by\nsetting the environment variable ``SQUONK2_LOGFILE`` when running the\napplication::\n\n SQUONK2_LOGFILE=./squeck.log squeck\n\nDebugging\n---------\n\n`Textual`_ doesn't like anything being written to the console so printing\n(even to ``stderr``) will topple the display. That's why ``stderr`` is\ndiverted when the application is running and nothing is printed.\nThere comes a time, though, when you need to see the error log.\nFor these times you can run **Squeck** without stderr diverted::\n\n squeck --enable-stderr\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The IM Squonk2 Deck (Squeck)",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/informaticsmatters/squonk2-deck"
},
"split_keywords": [
"configuration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "603d2df03ba2cdecc9bd6abc949995afbc9fdd0b8beb47128bfb1577426d0a07",
"md5": "7593c01d771d8497a6bbf2d6d3368674",
"sha256": "8176ee50e9d0bb53af8abbbc78871b44f02180a868f86042d161c95bd7760817"
},
"downloads": -1,
"filename": "im_squeck-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7593c01d771d8497a6bbf2d6d3368674",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8965,
"upload_time": "2023-07-08T09:22:50",
"upload_time_iso_8601": "2023-07-08T09:22:50.751998Z",
"url": "https://files.pythonhosted.org/packages/60/3d/2df03ba2cdecc9bd6abc949995afbc9fdd0b8beb47128bfb1577426d0a07/im_squeck-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "336bf27569ad838e9feb489f058560d0190f66d3d3911ac8f023902d64b0a4b0",
"md5": "52963a3b1d975090f5fc6014b9f1454f",
"sha256": "047e26e6d43e2c64bacdafd36bb33669fee8c5fbcdd3699f68a0fca088d6520d"
},
"downloads": -1,
"filename": "im-squeck-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "52963a3b1d975090f5fc6014b9f1454f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7878,
"upload_time": "2023-07-08T09:22:52",
"upload_time_iso_8601": "2023-07-08T09:22:52.209689Z",
"url": "https://files.pythonhosted.org/packages/33/6b/f27569ad838e9feb489f058560d0190f66d3d3911ac8f023902d64b0a4b0/im-squeck-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-08 09:22:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "informaticsmatters",
"github_project": "squonk2-deck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "im-squeck"
}
JSON
