Skip to main content
PyPI - Python Version PyPI GitHub GitHub Workflow Status GitHub Workflow Status

Squeck (Squonk2 Deck) is s Textual-UI (TUI) for the summary visualisation of multiple Squonk2 environments.

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

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

Metadata

Release files for im-squeck 2.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for im-squeck 2.1.0
File Size Uploaded
im_squeck-2.1.0.tar.gz 7.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for im-squeck 2.1.0
File Interpreter ABI Platform
im_squeck-2.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 16.4 kB

Release files / im_squeck-2.1.0.tar.gz

Download URL im_squeck-2.1.0.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
aeb71264a534d98c73db0bf33d5d026a47f6d18e7d37b9483ce8ec8b1534266e
BLAKE2b-256 checksum
How to use checksums
7a6fe88401f71353adacb63f5abaf7d75b39aded11b4521579135af5a040220b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 11, 2026.

Transparency log

Release files / im_squeck-2.1.0-py3-none-any.whl

Download URL im_squeck-2.1.0-py3-none-any.whl
Size 8.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
069e543ca745c7994b6ed25b7f4ef2d7a9cddd8d96f84033294a8c9ec32dea80
BLAKE2b-256 checksum
How to use checksums
8c63a88ba41cd266d9603bf603eae14481bd3869c68dba5c5e48f2c646b31230
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 11, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

2.1.0 This release

2 release files

2.0.0

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page