Project Overview

pyoncatqt is a Python package designed to enhance the graphical user interface (GUI) experience for developers using the pyoncat library. pyoncat is a Python package for interacting with the ONCat API.

Installation

Create and activate a virtual environment with Pixi. Prerequisites: Pixi installation e.g. for Linux:

curl -fsSL https://pixi.sh/install.sh | sh

Download the repository. Setup/Update the environment

pixi install

Enter the environment

pixi shell

List the pixi tasks that can run on the machine

pixi task list

The pyoncatqt environment is activated and the application is ready to use.

Development/Deployment

---

Any change to pyproject.toml, e.g. new dependencies, requires updating the pixi.lock file and including it in the commit.

pixi.lock

Testing

---

To run all tests for shiver

pytest
#or
python -m pytest
#or
pixi run test

To run pre-commit manually

pre-commit run --all-files

Or

To set the pre-commit hook before each git commit

pre-commit install