Skip to content

Commit 3923396

Browse files
committed
Reorganize how uv is explained
1 parent 3d48040 commit 3923396

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -77,30 +77,32 @@ LDFLAGS=-lwasi-emulated-mman \
7777
./scrapscript.py compile some.scrap --compile # produces a.out
7878
```
7979

80-
## Running Tests
80+
## Development Workflow
81+
82+
### Running Tests
8183

8284
```bash
8385
python scrapscript_tests.py
8486
```
85-
or
86-
```bash
87-
uv run python scrapscript_tests.py
88-
```
8987

90-
## Type Checking the Python Sources
88+
### Type Checking the Python Sources
9189
```bash
9290
mypy --strict scrapscript.py
9391
```
94-
or
95-
```
96-
uv run mypy --strict scrapscript.py
97-
```
9892

99-
## Formatting the Python Sources
93+
### Formatting the Python Sources
10094
```bash
10195
ruff format scrapscript.py
10296
```
103-
or
97+
98+
### Checking for Format Errors
10499
```bash
105-
uv run ruff format scrapscript.py
100+
ruff check scrapscript.py
101+
```
102+
103+
### Using `uv`
104+
If you choose to use `uv` to manage development dependencies, you can run any of the previous four commands by prefixing them with `uv run`, e.g.:
105+
106+
```shell
107+
uv run python scrapscript_tests.py
106108
```

0 commit comments

Comments
 (0)