Installation

mink is distributed on PyPI and supports Python 3.10 and above:

uv

uv add mink

pip

pip install mink

Verification

uv

uv run python -c "from mink import Configuration; print('OK')"

pip

python -c "from mink import Configuration; print('OK')"

Development Installation

Clone the repository and install all dependencies:

git clone https://github.com/kevinzakka/mink.git && cd mink
uv sync --all-groups

Common development commands:

make test      # Run tests
make check     # Run formatter (ruff) and type checkers (ty, pyright)
make doc       # Build documentation
make doc-live  # Build docs with live reload

See CONTRIBUTING.md for guidelines.