rmk2

Overview

This package serves as a personal toolbox, gathering various core functions that might come in handy when working on other projects or modules.

Installation

This project is written in python3.

It uses uv for dependency management, pytest for testing, and black for formatting.

Python environment

To retrieve the full source code and initialise a local virtual environment including required packages, run:

# Git
git clone https://gitlab.com/rmk2/rmk2-py.git

# uv (including dev dependencies)
uv sync 
# uv (excluding dev dependencies)
uv sync --no-dev

By default, uv sync will also install the package locally as an editable package.