ewoks install: support the uv package manager by woutdenolf · Pull Request #334 · ewoks-kit/ewoks

woutdenolf · 2026-08-19T15:21:08Z

No description provided.

codecov · 2026-08-19T15:25:11Z

Codecov Report

❌ Patch coverage is 87.00000% with 13 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/ewoks/_requirements/uv.py	86.86%	13 Missing ⚠️

📢 Thoughts on this report? Let us know!

woutdenolf · 2026-08-23T11:45:11Z

+        self._check_call("venv", "--python", python, environment.prefix)
+        return environment
+
+    def _files_from_distributions(


Note: I'm currently generation the pyproject.toml file and lock file from python's importlib.metadata (we need those already).

In the future it will try to detect and read those files first.

loichuder

Implementation looks good. Some suggestions for the doc though.

loichuder · 2026-08-27T12:14:58Z

 Without ``--env-root`` the :term:`package manager` decides where the environment goes. venv
-creates an environment wherever it is told to, so for pip-venv ewoks uses ``~/.ewoks/envs``.
+and uv create an environment wherever they are told to, so for pip-venv and uv ewoks uses
+``~/.ewoks/envs``.


This part is a bit confusing, perhaps we can reword it:

Suggested change

Without ``--env-root`` the :term:`package manager` decides where the environment goes. venv

creates an environment wherever it is told to, so for pip-venv ewoks uses ``~/.ewoks/envs``.

and uv create an environment wherever they are told to, so for pip-venv and uv ewoks uses

``~/.ewoks/envs``.

Use ``--env-root`` to choose where the environment will be created. Else, the :term:`package manager` will create it in a default folder (`~/.ewoks/envs` for pip-venv and uv)

Yes this was an LLM extraction of the full paragraph for all managers

Without ``--env-root`` the :term:`package manager` decides where the environment goes: conda creates it in its own environment directory (``conda config --show envs_dirs``), so ``conda activate <name>`` finds it, and poetry in the directory it creates project environments in (``poetry config virtualenvs.path``). venv, uv and pixi create an environment wherever they are told to, so for those ewoks uses ``~/.ewoks/envs``.

I think in the end a bullet-list is better. If you are ok I would like this leave this as it is and refactor ones all managers are included.

loichuder · 2026-08-27T12:16:39Z

+* ``--python-version`` is a request: uv can provide any python version but pip-venv can only
+  use the version of the python interpreter that creates the environment. A warning is emitted
+  when the version cannot be provided.


Suggested change

* ``--python-version`` is a request: uv can provide any python version but pip-venv can only

use the version of the python interpreter that creates the environment. A warning is emitted

when the version cannot be provided.

* ``--python-version`` is a request: `uv` can create an environment with any python version but `pip-venv` can only use the version of the python interpreter. A warning is emitted when the version cannot be satisfied.

The full paragraph is

* ``--python-version`` is a request: uv can provide any python version, conda and pixi provide the patch versions built by their channel, and pip-venv and poetry can only use the version of the python interpreter that creates the environment. A warning is emitted when the version cannot be provided.

Again I would like to leave this one as it is.

loichuder · 2026-08-27T12:25:13Z

+* ``--python-version`` is a request: uv can provide any python version but pip-venv can only
+  use the version of the python interpreter that creates the environment. A warning is emitted
+  when the version cannot be provided.
+* uv resolves the ``distributions`` into a lock file, which requires access to the package


I think it would be good to specify which part is about ewoks convert and which part is about ewoks install.

Suggested change

* uv resolves the ``distributions`` into a lock file, which requires access to the package

* Running `ewoks convert` with `uv` resolves the ``distributions`` into a lock file, which requires access to the package index.

Full version

* uv, poetry and pixi resolve the ``distributions`` into a lock file, which requires access to the package index. When that fails, a warning is emitted and the requirements are stored without files: the environment is then recreated from the ``distributions`` list.

loichuder · 2026-08-27T12:27:15Z

+  use the version of the python interpreter that creates the environment. A warning is emitted
+  when the version cannot be provided.
+* uv resolves the ``distributions`` into a lock file, which requires access to the package
+  index. When that fails, a warning is emitted and the requirements are stored without files:


Suggested change

index. When that fails, a warning is emitted and the requirements are stored without files:

index. If that fails, a warning is emitted and the distributions are stored as-is (without lock file). Running `ewoks install` will then create an environment only from the ``distributions`` list.

loichuder · 2026-08-27T12:27:47Z

+* uv resolves the ``distributions`` into a lock file, which requires access to the package
+  index. When that fails, a warning is emitted and the requirements are stored without files:
+  the environment is then recreated from the ``distributions`` list.
+* A lock file is only read by a :term:`package manager` that understands its format version, so


Are we only talking about uv here?

No, any package manager that has lock files.

loichuder · 2026-08-27T12:46:59Z

+        Package managers that create an environment wherever they are told to (venv
+        and uv) use a directory of ewoks.


I don't understand what "Package managers that create an environment wherever they are told to" and "use a directory of ewoks." mean.

directory of ewoks should be "~/.ewoks/envs".

Again the full version is

def environments_root(self) -> Path: """Root directory in which the package manager creates named environments. Package managers that create an environment wherever they are told to (venv, uv and pixi) use a directory of ewoks. """ return EWOKS_ENVIRONMENTS_ROOT

wherever they are told to -> For some package managers you cannot tell it to create a virtual environment on a specific location. This docstring needs improvement indeed.

loichuder · 2026-08-27T12:50:10Z

+def uv_environment(tmp_path) -> Iterator[Environment]:
+    """Environment of a uv project."""
+    if UvManager().version() is None:
+        pytest.skip("uv is not installed")


Should we add in the CONTRIBUTING that uv should be installed to run the full test suite?

Same for pixi etc. When everything is done you will see this in the CI and this can then be used to formulate the contributing.

loichuder · 2026-08-28T08:24:14Z

Ok to leave the documentation untouched until we have all package managers implemented 👍

Co-authored-by: Loïc Huder <42204205+loichuder@users.noreply.github.com> Co-authored-by: Wout De Nolf <wout.de_nolf@esrf.eu>

woutdenolf · 2026-08-28T08:33:48Z

I applied several doc fixes and will deal with the others when everything is done: #336.

ewoks install: support the uv package manager

f690760

woutdenolf requested a review from a team August 19, 2026 22:46

woutdenolf commented Aug 23, 2026

View reviewed changes

loichuder approved these changes Aug 27, 2026

View reviewed changes

woutdenolf mentioned this pull request Aug 28, 2026

Docs: ewoks install doc improvements #336

Open

woutdenolf commented Aug 28, 2026

View reviewed changes

Comment thread doc/howtoguides/requirements.rst Outdated

woutdenolf commented Aug 28, 2026

View reviewed changes

Comment thread doc/tutorials/install/uv.rst Outdated

woutdenolf commented Aug 28, 2026

View reviewed changes

Comment thread doc/tutorials/install/uv.rst Outdated

woutdenolf commented Aug 28, 2026

View reviewed changes

Comment thread doc/tutorials/install/uv.rst Outdated

Apply suggestions from code review

9a63bc2

Co-authored-by: Loïc Huder <42204205+loichuder@users.noreply.github.com> Co-authored-by: Wout De Nolf <wout.de_nolf@esrf.eu>

woutdenolf merged commit 870eae2 into main Aug 28, 2026
12 checks passed

	* uv resolves the ``distributions`` into a lock file, which requires access to the package
	* Running `ewoks convert` with `uv` resolves the ``distributions`` into a lock file, which requires access to the package index.

	index. When that fails, a warning is emitted and the requirements are stored without files:
	index. If that fails, a warning is emitted and the distributions are stored as-is (without lock file). Running `ewoks install` will then create an environment only from the ``distributions`` list.

		Package managers that create an environment wherever they are told to (venv
		and uv) use a directory of ewoks.

Uh oh!

Conversation

woutdenolf commented Aug 19, 2026

Uh oh!

codecov Bot commented Aug 19, 2026

Codecov Report

Uh oh!

woutdenolf Aug 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

loichuder left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

woutdenolf Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

loichuder Aug 27, 2026 • edited by woutdenolf Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

woutdenolf Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

loichuder commented Aug 28, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

woutdenolf commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

woutdenolf Aug 23, 2026 •

edited

Loading

woutdenolf Aug 28, 2026 •

edited

Loading

loichuder Aug 27, 2026 •

edited by woutdenolf

Loading

woutdenolf Aug 28, 2026 •

edited

Loading

woutdenolf commented Aug 28, 2026 •

edited

Loading