Developer Setup

Prerequisites

  • Python 3.10 or later

  • git

Clone and Install

git clone https://github.com/SETI/rms-link-checker.git
cd rms-link-checker
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e ".[dev]"

Verify the installation:

link_check --version
pytest -n auto --cov

Running All Checks

./scripts/run-all-checks.sh

This runs ruff, mypy, pytest (with coverage), Sphinx build, and PyMarkdown.