Skip to content

Commit 1c6bfa8

Browse files
committed
Updating contribution for uv
1 parent f401519 commit 1c6bfa8

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@ Request features on the [Issue Tracker].
3939

4040
You need Python 3.10+ and the following tools:
4141

42-
- [Poetry]
42+
- [uv]
4343
- [Nox]
44-
- [nox-poetry]
4544

4645
Another alternative is to use a [Development Container] has been setup to provide
4746
an environment with the required dependencies. This facilitates development on
@@ -55,23 +54,22 @@ This should seamlessly enable development for users of [VS Code] on systems with
5554

5655
## How to Install and Run MDIO
5756

58-
Install the package with development requirements:
57+
Install the package with development and documentation generation requirements:
5958

6059
```console
61-
$ poetry install
60+
$ uv sync --all-groups
6261
```
6362

6463
You can now run an interactive Python session,
6564
or the command-line interface:
6665

6766
```console
68-
$ poetry run python
69-
$ poetry run mdio
67+
$ uv run python
68+
$ uv run mdio
7069
```
7170

72-
[poetry]: https://python-poetry.org/
71+
[uv]: https://docs.astral.sh/uv/
7372
[nox]: https://nox.thea.codes/
74-
[nox-poetry]: https://nox-poetry.readthedocs.io/
7573
[development container]: https://containers.dev/
7674
[vs code]: https://code.visualstudio.com/docs/devcontainers/containers/
7775

0 commit comments

Comments
 (0)