Contributing

Thank you for helping improve weather-tools.

Reporting issues

1. Search existing issues on Codeberg.
2. Open a new issue with rain --version, Python version, and steps to reproduce.

Development setup

git clone https://codeberg.org/marvin8/weather_tools.git
cd weather_tools
uv sync --group dev --group pytest

Install the package in editable mode for local runs:

uv pip install -e .

Checks

Typical commands (see noxfile.py for the full list of sessions):

uv run ruff format --check src/
uv run ruff check src/
uv run ty check src/
uv run pytest tests/
uv run nox --list

Documentation

• Published: https://marvin8.codeberg.page/weather_tools/
• Source lives in the repository’s docs/ directory.
• Configuration: mkdocs.yml at the repo root.
• Local preview:

uv sync --group dev
uv run mkdocs serve

Versioned publishing uses mike (mike deploy …) in CI on release tags, writing to the pages branch (see .woodpecker/publish-docs.yml).

License

By contributing, you agree your contributions are licensed under AGPL-3.0-or-later (same as the project).