Installation

Requirements

  • Python 3.10, 3.11, or 3.12

  • Git (git executable available on PATH)

  • uv (recommended) or pip

Note

Git is a system dependency used for repository commit lookup (for example via git ls-remote). It is not managed through pyproject.toml and must be installed separately.

Install from PyPI

Using pip

pip install sw-metadata-bot

Optional extras for documentation, tests, and development tooling are exposed through the package metadata:

pip install "sw-metadata-bot[docs]"
pip install "sw-metadata-bot[test]"
pip install "sw-metadata-bot[dev]"

From source for contributors

git clone https://github.com/SoftwareUnderstanding/sw-metadata-bot.git
cd sw-metadata-bot
uv sync
uv run sw-metadata-bot --help

For local development with the optional dependency sets declared in pyproject.toml:

pip install -e ".[dev,test,docs]"