You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developer-notes.md
+15-3Lines changed: 15 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,15 +21,27 @@ pip install --upgrade pip
21
21
pip install -e .
22
22
```
23
23
24
-
## Lint
24
+
## Formatting & linting
25
25
26
26
This project primarily uses the `uv` python packaging tool: https://docs.astral.sh/uv/ along with the sister formatter/linter `ruff`https://docs.astral.sh/ruff/
27
27
28
+
Refer to the `uv` documentation for installation methods: https://docs.astral.sh/uv/getting-started/installation/
29
+
28
30
With `uv` installed you can add/remove dependencies using `uv add <dep>` or `uv remove <dep>.
29
31
This will update the [`uv.lock`](https://docs.astral.sh/uv/guides/projects/#uvlock) file automatically.
30
32
33
+
We use ruff version 0.6.8 in this project currently. This can be installed as a stand-alone binary (see documentation), or via `uv` using:
34
+
35
+
```bash
36
+
# install
37
+
$ uv tool install ruff@0.6.8
38
+
39
+
# lint
40
+
$ uvx ruff@0.6.8 check .
31
41
32
-
`uv` can also run tools (like `ruff`) without external installation, simply run `uvx ruff check .` or `uvx ruff format .` to use a uv-managed format/lint on the project.
0 commit comments