Skip to content

Commit bdde723

Browse files
committed
chore: document using uv
1 parent a018c17 commit bdde723

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/contributing.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,3 +369,29 @@ and rtfd.io. This checklist is a reminder of the required steps.
369369
(Unfortunately the checksums do not match due to timestamps in the metadata
370370
so you need to compare all the files.)
371371
- Once happy that the above comparison checks out, approve the releases to Pypi.org.
372+
373+
374+
Errata
375+
======
376+
377+
Development with astral uv package and project manager.
378+
-------------------------------------------------------
379+
380+
We have experimental support for `astral uv <https://docs.astral.sh/uv/>`__. It provides an improved
381+
developer experience over vanilla virtualenv/venv and pip by managing multiple python versions,
382+
virtual environments and dependencies in a more efficient way. The ``uv run`` command automatically
383+
syncs dependencies and python version before running the command, saving multiple steps when
384+
working on multiple branches with different dependencies.
385+
386+
You can use uv sync to set up your environment and install dependencies and run python::
387+
388+
... code-block:: bash
389+
uv sync # checks deps, installs virtualenv and dependencies as necessary
390+
uv run ... # runs command in the uv environment, syncs deps and python version first if necessary
391+
392+
To run tox uv use `tox uv <https://github.com/tox-dev/tox-uv>`__::
393+
394+
... code-block:: bash
395+
uv tool install tox --with tox-uv # use uv to install
396+
tox --version # validate you are using the installed tox
397+
tox r -e py312 # will use uv

0 commit comments

Comments
 (0)