Installation¶
Using uv (Recommended)¶
This project uses uv for fast, reliable package management:
# Install uv (if not already installed)
pip install uv
# Install the package
uv sync
# Or install with development dependencies
uv sync --extra dev
Using pip¶
From Source¶
# Clone the repository
git clone https://github.com/jpsferreira/climb-sensei.git
cd climb-sensei
# Install with uv
uv sync
# Or with pip
pip install -e .
Development Installation¶
For development, install with all extras:
This includes:
- pytest & pytest-cov for testing
- ruff for linting
- black for code formatting
- pre-commit for git hooks
- mkdocs-material for documentation
Verify Installation¶
Requirements¶
- Python 3.12 or higher
- macOS, Linux, or Windows
- Webcam or video files for analysis
Core Dependencies¶
- mediapipe >= 0.10.30: Pose estimation
- opencv-python >= 4.8.0: Video I/O and visualization
- numpy >= 1.24.0: Numerical computations
- tqdm >= 4.66.0: Progress bars
Development Dependencies¶
- pytest >= 9.0.0: Testing framework
- pytest-cov >= 7.0.0: Coverage reporting
- black >= 24.0.0: Code formatting
- ruff >= 0.9.0: Linting
- pre-commit >= 4.0.0: Git hooks
- mkdocs-material >= 9.0.0: Documentation