Skip to content

Commit fa3657d

Browse files
committed
doc: update README.md
1 parent e9b53b6 commit fa3657d

1 file changed

Lines changed: 20 additions & 9 deletions

File tree

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
🌐 **Live API:** https://notes21.onrender.com/
77
📘 **Swagger Docs:** https://notes21.onrender.com/docs
88

9+
## 🐍 Python Version
10+
11+
notes21 requires **Python 3.13 or newer**.
12+
913
A tonal computation engine based on a structured **7×3 grid representation** of music.
1014

1115
notes21 provides:
@@ -54,24 +58,31 @@ src/notes21/
5458

5559
## ⚙️ Setup (local environment)
5660

57-
Create and activate a virtual environment:
61+
This project uses **uv** for dependency management and commits a `uv.lock`
62+
file to ensure deterministic builds across local, CI, and production.
63+
64+
Install uv (macOS example):
5865

5966
```bash
60-
python3 -m venv .venv
61-
source .venv/bin/activate
67+
brew install uv
6268
```
6369

64-
Install the project (runtime dependencies included):
70+
For Linux, Windows, and other installation methods, see the official uv installation guide:
71+
72+
https://docs.astral.sh/uv/getting-started/installation/
73+
74+
Create and activate a virtual environment:
6575

6676
```bash
67-
pip install -e .
77+
uv venv
78+
source .venv/bin/activate
6879
```
6980

70-
Install development dependencies:
81+
Install dependencies (including development dependencies):
7182

7283
```bash
73-
pip install -e ".[dev]"
74-
```
84+
uv sync --extra dev
85+
```
7586

7687
---
7788

@@ -114,7 +125,7 @@ curl "http://127.0.0.1:8000/grid?note=Db&key=C&format=text"
114125
Run the test suite:
115126

116127
```bash
117-
pytest
128+
uv run pytest
118129
```
119130

120131
---

0 commit comments

Comments
 (0)