{"id":21721341,"url":"https://github.com/informaticsmatters/squonk2-deck","last_synced_at":"2026-01-27T11:32:14.816Z","repository":{"id":59822995,"uuid":"527154917","full_name":"InformaticsMatters/squonk2-deck","owner":"InformaticsMatters","description":"A textual summary of Squonk2 environments","archived":false,"fork":false,"pushed_at":"2024-07-30T08:19:21.000Z","size":1233,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-01T00:37:47.846Z","etag":null,"topics":["squonk2"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/InformaticsMatters.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-21T09:04:08.000Z","updated_at":"2024-07-30T08:19:25.000Z","dependencies_parsed_at":"2024-07-30T11:39:12.868Z","dependency_job_id":null,"html_url":"https://github.com/InformaticsMatters/squonk2-deck","commit_stats":{"total_commits":12,"total_committers":2,"mean_commits":6.0,"dds":0.08333333333333337,"last_synced_commit":"c08ea0d02bdebe4db9a6e6dd799a7aede3137c0b"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-deck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-deck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-deck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InformaticsMatters%2Fsquonk2-deck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InformaticsMatters","download_url":"https://codeload.github.com/InformaticsMatters/squonk2-deck/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246275105,"owners_count":20751219,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["squonk2"],"created_at":"2024-11-26T02:15:58.787Z","updated_at":"2026-01-27T11:32:14.780Z","avatar_url":"https://github.com/InformaticsMatters.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"############\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finformaticsmatters%2Fsquonk2-deck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finformaticsmatters%2Fsquonk2-deck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finformaticsmatters%2Fsquonk2-deck/lists"}