ML.CBE Hackathon

Quick Start

• Fork this repo and clone your fork

git clone <your-fork-url>
cd ML_cbe

Prerequisites

• Python ≥ 3.12
• uv (recommended). On Windows PowerShell:

irm https://astral.sh/uv/install.ps1 | iex

Project Structure

.
├─ main.py
├─ pyproject.toml
├─ README.md
├─ uv.lock
├─ .python-version
└─ .vscode/

Dependency Management (uv)

• Add a dependency:

uv add <package>
uv sync

• Remove a dependency:

uv remove <package>
uv sync

• Upgrade locked dependencies:

uv sync --upgrade

Dependencies are declared in pyproject.toml and pinned in uv.lock.

Troubleshooting

• uv: command not found on Windows: install via PowerShell

irm https://astral.sh/uv/install.ps1 | iex

• PowerShell script execution blocked when activating venv:

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass

License

TBD

• Create a virtual environment and install dependencies

uv venv .venv
uv sync

• Run the app (choose one):

# Without activating the venv (uv handles it)
uv run python main.py

# Or, activate then run
./.venv/Scripts/Activate.ps1
python main.py

• Before making changes, create a feature branch

git checkout -b <branch-name>