Metadata-Version: 2.4
Name: rmk2
Version: 1.3.0
Summary: rmk2's Python Toolbox
Project-URL: Repository, https://gitlab.com/rmk2/rmk2-py
Author-email: rmk2 <ryko@rmk2.org>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Requires-Python: >=3.14
Description-Content-Type: text/markdown

# 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.
