kyoslib_py 5.5.0

KYOS shared lib code as python package

kyoslib_py

Usage

Example code:

from kyoslib_py.simulation import Simulation
simulation_set = Simulation()

Installation

pip install kyoslib_py

Dependencies

Python 3.11+

Development

This project is executing CI checks using GitHub actions.

It will run pytest and black.

Invoking development tasks

Invoke is used for development tasks.

Tasks are stored in tasks.py and are executable using the inv[oke] command line tool.

To see the list of tasks, you can type:

inv --list

For example, before your commits, you should run

inv format

to format your code.

Documentation

The package documentation is generated by MkDocs. The correct version can be installed in the project's virtual environment by:

poetry install

Then the documentation can be built, and a server to view it started by:

mkdocs serve