#TODO: document
This project uses uv
, a fast Python package manager and workflow tool. uv
is used for installing dependencies, running scripts, and managing virtual environments in a reproducible way.
Note: Using
uv
is recommended for consistency, but it is not strictly required. You could usepip
and standard Python tools instead; however, onlyuv
-based workflows are documented here.
- Speed: Much faster than pip for installing and resolving dependencies.
- Reproducibility: Ensures consistent environments across machines.
- Convenience: Can run Python scripts and manage virtual environments easily.
To install uv
, run:
pip install uv
Or see the uv installation guide for other options and the latest instructions.
Install dependencies:
uv pip install .[dev]
Synchronize dependencies exactly as specified in your lock files (for reproducible environments):
uv sync
This will install all dependencies (including optional groups like [dev]
if specified in your lock file) to exactly match the versions in your uv.lock
or requirements.lock
file. Use uv sync
after updating dependencies or when setting up a new environment to ensure consistency.
Run a script:
uv run scripts/mcp_test_client.py
You can use uv
as a drop-in replacement for many common pip and python commands in this project.