Switch to uv for dependency management and add more thorough instructions

.gitignore

@@ -10,4 +10,5 @@ __pycache__/*
 *~
 *.swp
 *.swo
+*.swn
 stats.*.pickle

.python-version

@@ -0,0 +1 @@
+3.13

README.md

@@ -28,15 +28,48 @@ It combines classic Computer Vision heuristics (blur / exposure tests, kinematic
 
 ## ⚙️  Installation
 
-```bash
-# clone your repo first
-pip install -r requirements.txt
-export GOOGLE_API_KEY="sk-..."      # Required only if you use VLM-based scoring
-
-## Example
-HF_USER='...'
-python score_dataset.py --dataset /path/to/data/${HF_USER}/open-book --task "Open the book"
+### Installation
 ```
+git clone git@github.com:RoboticsData/score_lerobot_episodes.git
+cd score_lerobot_episodes
+
+uv venv
+source .venv/bin/activate
+uv sync  # installs dependencies expressed in pyproject.toml and uv.lock
+
+python -c 'import score_dataset' || echo 'Something is wrong, check dependencies'
+
+# Test if you're logged into the hugginface CLI:
+hf auth whoami
+# If not, go to https://huggingface.co/settings/tokens, make a new token, and login:
+hf auth login
+```
+
+### Usage
+
+```
+# in the score_lerobot_episodes directory:
+
+source .venv/bin/activate
+
+# Fetch a dataset from HuggingFace, example:
+PATH_TO_HF_DATASET=`hf download Rorschach4153/so101_60_new --repo-type dataset`
+
+## TODO make tool injest HF repo names instead of local paths to cached snapshots
+python score_dataset.py --dataset ${PATH_TO_HF_DATASET} --task "none" --camera 'phone'
+```
+
+### Adding dependencies
+
+Use ```uv add``` to add dependencies, then ensure you commit changes to pyproject.toml and uv.lock.
+
+#### Python versions
+
+We opt for keeping ```.python-version``` in the repo as a way to interlock the Python
+runtime version with installed dependecy versions. Python packages express
+dependence on difference Python versions, so Python itself effectively becomes
+a dependency.
+
 
 ## Star History
 

pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "score-lerobot-episodes"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "dotenv>=0.9.9",
+    "google-generativeai>=0.8.5",
+    "huggingface-hub[cli]>=0.34.3",
+    "numpy>=2.3.2",
+    "opencv-python>=4.11.0.86",
+    "pandas>=2.3.1",
+    "pyarrow>=21.0.0",
+    "uniplot>=0.21.3",
+]