Skip to content

Commit d4494ce

Browse files
authored
docs: remove unsupported uv sync setup step
1 parent 6b75fa3 commit d4494ce

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -535,14 +535,16 @@ We welcome contributions! The project has comprehensive test coverage and develo
535535
poetry install # Installs runtime + dev deps (including ruff, pytest)
536536
```
537537
<details>
538-
<summary><b>Alternative: develop with <a href="https://docs.astral.sh/uv/">uv</a> (best-effort supported)</b></summary>
538+
<summary><b>Alternative: use <a href="https://docs.astral.sh/uv/">uv</a> as a command runner</b></summary>
539539

540-
Poetry remains the canonical dev tool — `poetry.lock` is the lockfile CI tests against. uv is supported as an alternative for contributors who prefer it:
540+
Poetry remains the canonical dev tool — `poetry.lock` is the lockfile CI tests against.
541+
This repo currently uses Poetry metadata (`[tool.poetry]`) without a `[project]` table, so `uv sync` is not supported here.
542+
If you prefer uv ergonomics, install deps with Poetry first and then use uv only to run commands:
541543
```bash
542-
uv sync # Reads pyproject.toml deps, builds a transient uv.lock (gitignored)
544+
poetry install
543545
uv run pytest
544546
```
545-
Caveat: the transient `uv.lock` is not committed (avoids drift with `poetry.lock`), so your resolved versions may differ from what CI tests. Full uv migration deferred until snyk supports `uv.lock` natively ([snyk-python-plugin#251](https://github.com/snyk/snyk-python-plugin/issues/251)).
547+
Full uv migration remains deferred until snyk supports `uv.lock` natively ([snyk-python-plugin#251](https://github.com/snyk/snyk-python-plugin/issues/251)).
546548
</details>
547549

548550
### Development Workflow

0 commit comments

Comments
 (0)