Skip to content

Commit

Permalink
docs: Document compatibility with uv projects
Browse files Browse the repository at this point in the history
  • Loading branch information
nat-n committed Nov 24, 2024
1 parent 0d5025e commit 333f10c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/guides/without_poetry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ By default poe will run tasks in the poetry managed virtual environment, if the
If no virtualenv is found then poe will run tasks without any special environment management.


Usage with uv
-------------

|uv_link| is another popular tool for managing project dependencies with a pyproject.toml file. Since uv works by keeping a virtual environment inside the project directory at ``./.venv`` poethepoet will automatically discover and use uv project dependencies, just like with poetry.

So Poe the Poet also works well with uv.


Usage without pyproject.toml
----------------------------

Expand Down Expand Up @@ -62,6 +70,9 @@ When config is loaded from a file other than `pyproject.toml` the ``tool.poe`` n
options: ["--var"]
default: BAZ
.. |uv_link| raw:: html

<a href="https://docs.astral.sh/uv/" target="_blank">uv</a>

.. |poetry_link| raw:: html

Expand Down

0 comments on commit 333f10c

Please sign in to comment.