Metadata-Version: 2.4
Name: umbi
Version: 0.2.2
Summary: Library for input/output of transition systems in a unified Markov binary (UMB) format.
Author-email: Roman Andriushchenko <roman.andriu@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/randriu/umbi
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: marshmallow
Requires-Dist: marshmallow_oneofschema
Requires-Dist: bitstring
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pyright; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: toml-sort; extra == "dev"
Requires-Dist: uv; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: bump-my-version; extra == "dev"
Dynamic: license-file

# umbi

Library for input/output of transition systems in a *unified Markov binary (UMB)* format.

## Installation:

(optional) create and activate a python environment:

```bash
python -m venv .venv
source .venv/bin/activate
```

Install `umbi` via
```bash
pip install umbi
```

## Running umbi

Examples:
```bash
umbi --import-umb /path/to/input.umb
umbi --import-umb /path/to/input.umb --export-umb /path/to/output.umb
umbi --import-umb /path/to/input.umb --export-umb /path/to/output.umb --log-level=DEBUG
```

## Development

### Setup

Install development dependencies:

```bash
pip install .[dev]
```

### Code Quality

Pre-commit hooks automatically run code quality checks before each commit. Configuration: [.pre-commit-config.yaml](.pre-commit-config.yaml)

Set up the hooks with:

```bash
pre-commit install
```

Run hooks manually on all files:

```bash
pre-commit run --all-files
```

Individual tools can be run manually:

**[Ruff](https://github.com/astral-sh/ruff)** -- Code formatting and linting. Config: [pyproject.toml](pyproject.toml) (`[tool.ruff]`)
```bash
ruff check .       # check for issues
ruff format .      # format code
ruff check . --fix # check and fix
```

**[Pyright](https://github.com/microsoft/pyright)** -- Static type checking. Config: [pyproject.toml](pyproject.toml) (`[tool.pyright]`)
```bash
pyright             # check entire project
pyright umbi/       # check specific directory
```

#### Lockfiles

Dependencies are pinned in the [uv.lock](uv.lock) lockfile for reproducible builds. The lockfile is automatically updated via pre-commit hooks when [pyproject.toml](pyproject.toml) changes. To update manually:

```bash
uv lock
```
