Skip to content

Commit 7eb85e2

Browse files
Update README.md (#240)
It now recommends that users use `uv` and `scrapscript_tests.py` for testing.
1 parent 20ada10 commit 7eb85e2

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +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
83+
84+
```bash
85+
python scrapscript_tests.py
86+
```
87+
88+
### Type Checking the Python Sources
89+
```bash
90+
mypy --strict scrapscript.py
91+
```
92+
93+
### Formatting the Python Sources
94+
```bash
95+
ruff format scrapscript.py
96+
```
97+
98+
### Checking for Format Errors
99+
```bash
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.:
81105

82106
```bash
83-
python3 scrapscript.py test
107+
uv run python scrapscript_tests.py
84108
```

0 commit comments

Comments
 (0)