Skip to content

Commit 8151bd8

Browse files
committed
docs: make README uv-first
1 parent 7f7a3a9 commit 8151bd8

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ __pycache__/
99
*.stale
1010
tmp_*.jsonl
1111
benchmarks/generated/
12+
uv.lock

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,20 @@ If `json.loads()` is too strict and Python-side repair is too slow, this is the
2626
## Install
2727

2828
```bash
29-
pip install repairjson
29+
uv add repairjson
30+
```
31+
32+
For a plain virtual environment:
33+
34+
```bash
35+
uv venv
36+
VIRTUAL_ENV=.venv uv pip install --python .venv/bin/python repairjson
3037
```
3138

3239
## Fast Example
3340

3441
```bash
35-
python -c "import repairjson; print(repairjson.repair(\"{user: 'alice', active: True, tags: ['x', 'y',],}\"))"
42+
uv run --with repairjson python -c "import repairjson; print(repairjson.repair(\"{user: 'alice', active: True, tags: ['x', 'y',],}\"))"
3643
```
3744

3845
Output:
@@ -77,7 +84,7 @@ The full benchmark harness and development test setup live on the `dev` branch.
7784
Create the local environment and install the package in editable mode:
7885

7986
```bash
80-
python3 -m venv .venv
81-
.venv/bin/python -m pip install --upgrade pip maturin
82-
.venv/bin/maturin develop
87+
uv venv
88+
VIRTUAL_ENV=.venv uv pip install --python .venv/bin/python maturin
89+
uv run maturin develop
8390
```

0 commit comments

Comments
 (0)