This project uses uv for Python package and environment management.
Install uv:
# Windows (PowerShell)
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh- Create virtual environment:
uv venv- Activate the environment:
# Windows
.venv\Scripts\activate
# macOS/Linux
source .venv/bin/activate- Install dependencies:
# Install from pyproject.toml
uv pip install -e .
# Or install specific packages
uv pip install package-name# Run Python scripts
uv run python app.py
# Install a package
uv pip install requests
# Install dev dependencies
uv pip install pytest black ruff
# List installed packages
uv pip list
# Upgrade a package
uv pip install --upgrade package-nameThis project uses markdownlint-cli2 to ensure consistent Markdown formatting.
- Open the project in VS Code
- Install the markdownlint extension by David Anson (Ctrl+Shift+X → search "markdownlint")
- Edit any
.mdfile - See warnings appear as you type (wavy underlines)
- View all errors in Problems panel (Ctrl+Shift+M)
Note: The markdownlint extension shows errors but does NOT auto-fix them. You must fix issues manually.
# Check all files
uv run markdownlint-cli2 "docs/**/*.md" "*.md"
# Check specific file
uv run markdownlint-cli2 docs/DEVELOPMENT_PLAN.mdpyproject.toml- Project configuration and dependencies.python-version- Python version specification (3.11).venv/- Virtual environment (auto-created by uv).vscode/- VS Code settings