Skip to content

Commit 66149e1

Browse files
Update contributing guide to use uv instead of poetry
Replaces instructions for installing and using poetry and maturin with uv for dependency management. Simplifies setup steps and updates test instructions accordingly.
1 parent 1951872 commit 66149e1

File tree

1 file changed

+4
-18
lines changed

1 file changed

+4
-18
lines changed

docs/contributing.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,18 @@ My goal for this project is:
1414

1515
Pre-requisite packages:
1616

17-
- Install [poetry](https://python-poetry.org/)
18-
- Install [pipx](https://pipx.pypa.io/stable/installation/)
19-
- Install [maturin](https://www.maturin.rs/tutorial)
17+
- Install [uv](https://astral.sh/uv)
2018

2119
Then do the modifications to the [lib.rs]{.title-ref} file and add test
2220
in tests directory.
2321

24-
1. Install **poetry** dependencies:
22+
1. Install **uv** dependencies:
2523

2624
```sh
27-
poetry install
25+
uv sync
2826
```
2927

30-
2. Activate **poetry** shell:
31-
32-
```sh
33-
poetry shell
34-
```
35-
36-
3. Build with **maturin**:
37-
38-
```sh
39-
maturin develop
40-
```
41-
42-
4. Run tests:
28+
2. Run tests:
4329

4430
```sh
4531
pytest .

0 commit comments

Comments
 (0)