Skip to content

Installation

Prerequisites

  • Python 3.11–3.14 (requires-python in pyproject.toml)
  • uv or pip
git clone https://codeberg.org/marvin8/rainlog.git
cd rainlog
uv sync

Install the package into the active environment (editable or not):

uv pip install .

The console script is rainlog.

Published documentation

The versioned manual (MkDocs + mike) lives at https://marvin8.codeberg.page/rainlog/.

Documentation tooling

Published docs are built with MkDocs, Material, and versioned with mike. To work on docs locally:

uv sync --group dev
uv run mkdocs serve

Build a static site:

uv run mkdocs build

Verify

rainlog --help
rainlog --version

Next steps