Merge pull request #136 from mokagio/uv-dev-workflow

Recommend `uv` for contributor workflow in `README`

Author: robamu

README.md

@@ -33,53 +33,56 @@ It also contains various helper modules which are commonly used when working wit
 
 # Install
 
-You can install this package from PyPI
-
-For example, using [`uv`](https://docs.astral.sh/uv/)
-
-Setting up virtual environment:
+You can install this package from PyPI:
 
 ```sh
-uv venv
+pip install spacepackets
 ```
 
-Regular install:
+For example, using [`uv`](https://docs.astral.sh/uv/):
 
 ```sh
-uv pip install -e .
+uv pip install spacepackets
 ```
 
-Interactive install with testing support:
+# Examples
+
+You can find all examples [inside the documentation](https://spacepackets.readthedocs.io/en/latest/examples.html).
+
+
+# Contributing
+
+For local development from a checkout, sync the project environment and development tools:
 
 ```sh
-uv pip install -e ".[test]"
+uv sync --group dev
 ```
 
-# Examples
-
-You can find all examples [inside the documentation](https://spacepackets.readthedocs.io/en/latest/examples.html).
+To include test dependencies:
 
+```sh
+uv sync --group dev --extra test
+```
 
 # Tests
 
-If you want to run the tests, it is recommended to install `pytest` and `coverage` (optional)
-first. You also have to install the package with the optional `test` feature:
+If you want to run the tests, you have to install the package with the optional `test` feature:
 
 ```sh
-uv pip install -e ".[test]"
+uv sync --group dev --extra test
 ```
 
 Running tests regularly:
 
 ```sh
-pytest
+uv run pytest
 ```
 
 Running tests with coverage:
 
 ```sh
-coverage run -m pytest
-coverage report
+uv run coverage run -m pytest
+uv run coverage report
 ```
 
 # Documentation
@@ -90,7 +93,7 @@ The documentation is built with Sphinx and new documentation should be written u
 Install the required dependencies first:
 
 ```sh
-pip install -r docs/requirements.txt
+uv pip install -r docs/requirements.txt
 ```
 
 Then the documentation can be built with
@@ -111,11 +114,11 @@ make doctest
 Linting:
 
 ```sh
-ruff check
+uv run ruff check
 ```
 
 Formatting:
 
 ```sh
-ruff format
+uv run ruff format
 ```

pyproject.toml

@@ -121,3 +121,8 @@ addopts = [
   "--ignore=benchmarks"
 ]
 testpaths = ["tests"]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.15.5",
+]