================================= ================================= =============================
Documentation <documentation_> `Read the Docs <documentation>_ |documentation badge| Issues _GitHub
Repository <repository_> `GitHub <repository>_ |repository badge| Tests _GitHub Actions _ |tests badge| Coverage _Codecov
Distribution <distribution_> `PyPI <distribution>`_ | |version badge|
| |python versions badge|
| |python interpreters badge|
================================= ================================= =============================
This is an exploratory application using QTrio.
In general, it will provide visually laid out widgets for data dashboards.
The data will be read and set over Modbus TCP using the SunSpec high level protocol.
.. _Qtrio: https://qtrio.readthedocs.io/en/stable/ .. _SunSpec: https://sunspec.org/
This application is not yet published to PyPI nor built into directly runnable packages.
It is installable via either cloning and installing or directly via the Git repository.
When installing the Python package itself, it is recommended to work in a virtual environment.
For a quick introduction, see Python Virtual Environments in Five Minutes <virtual_environments_>_.
.. tab:: Unix/macOS
.. code-block:: console
$ myvenv/bin/pip install git+https://github.com/altendky/ssst.. tab:: Windows
.. code-block:: console
$ myvenv/scripts/pip install git+https://github.com/altendky/ssst.. _virtual_environments: https://chriswarrick.com/blog/2018/09/04/python-virtual-environments/
Two main means of launching the application are provided.
A directly runnable console script and a Python module runnable using python -m.
.. tab:: Unix/macOS
.. code-block:: console
$ myvenv/bin/ssst gui
.. code-block:: console
$ myvenv/bin/python -m ssst gui.. tab:: Windows
.. code-block:: console
$ myvenv/scripts/ssst gui
.. code-block:: console
$ myvenv/scripts/python -m ssst gui.. documentation: https://ssst.readthedocs.io
.. |documentation badge| image:: https://img.shields.io/badge/docs-read%20now-blue.svg?color=royalblue&logo=Read-the-Docs&logoColor=whitesmoke
:target: documentation
:alt: Documentation
.. distribution: https://pypi.org/project/ssst
.. |version badge| image:: https://img.shields.io/pypi/v/ssst.svg?color=indianred&logo=PyPI&logoColor=whitesmoke
:target: distribution
:alt: Latest distribution version
.. |python versions badge| image:: https://img.shields.io/pypi/pyversions/ssst.svg?color=indianred&logo=PyPI&logoColor=whitesmoke
:alt: Supported Python versions
:target: distribution_
.. |python interpreters badge| image:: https://img.shields.io/pypi/implementation/ssst.svg?color=indianred&logo=PyPI&logoColor=whitesmoke
:alt: Supported Python interpreters
:target: distribution_
.. issues: https://github.com/altendky/ssst/issues
.. |issues badge| image:: https://img.shields.io/github/issues/altendky/ssst?color=royalblue&logo=GitHub&logoColor=whitesmoke
:target: issues
:alt: Issues
.. repository: https://github.com/altendky/ssst
.. |repository badge| image:: https://img.shields.io/github/last-commit/altendky/ssst.svg?color=seagreen&logo=GitHub&logoColor=whitesmoke
:target: repository
:alt: Repository
.. tests: https://github.com/altendky/ssst/actions?query=branch%3Amain
.. |tests badge| image:: https://img.shields.io/github/workflow/status/altendky/ssst/CI/main?color=seagreen&logo=GitHub-Actions&logoColor=whitesmoke
:target: tests
:alt: Tests
.. coverage: https://codecov.io/gh/altendky/ssst
.. |coverage badge| image:: https://img.shields.io/codecov/c/github/altendky/ssst/main?color=seagreen&logo=Codecov&logoColor=whitesmoke
:target: coverage
:alt: Test coverage