Skip to content

BLD/DOC: uv install instructions #31804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
scottshambaugh wants to merge 1 commit into
base: main
Choose a base branch
from
+54 −0
Open

BLD/DOC: uv install instructions #31804

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions doc/devel/development_setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ setup.

.. _venv: https://docs.python.org/3/library/venv.html
.. _conda: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
.. _uv: https://docs.astral.sh/uv/

.. tab-set::

Expand Down Expand Up @@ -182,6 +183,59 @@ setup.

Remember to activate the environment whenever you start working on Matplotlib!

.. tab-item:: uv environment

`uv`_ is a fast drop-in replacement for ``pip`` and ``venv``. After
`installing uv <https://docs.astral.sh/uv/getting-started/installation/>`_,
create a new environment and install the Python dependencies with ::

uv venv
uv pip install --group dev

and activate it with one of the following :

.. tab-set::

.. tab-item:: Linux and macOS

.. code-block:: bash

source .venv/bin/activate

.. tab-item:: Windows cmd.exe

.. code-block:: bat

.venv\Scripts\activate.bat

.. tab-item:: Windows PowerShell

.. code-block:: ps1con

.venv\Scripts\Activate.ps1

Remember to activate the environment whenever you start working on Matplotlib!

.. note::

When using uv, prefix the remaining ``pip`` commands in this guide with
``uv``. For example, the :ref:`editable install <development-install>`
below becomes ::

uv pip install --verbose --no-build-isolation --group dev --editable .

You can also manage the environment from a lockfile with ``uv sync``.
Because Matplotlib has a compiled (meson-python) build, install the
dependencies and the editable build in separate steps ::

uv sync --group dev --no-install-project
uv pip install --no-build-isolation --no-deps --editable .

Then activate the environment as above. Avoid ``uv run``, because it
re-syncs the project and rebuilds the editable install with build
isolation, which is incompatible with the meson-python editable rebuild.
``uv run --no-sync`` will work around this.

.. tab-item:: conda environment

Create a new `conda`_ environment and install the Python dependencies with ::
Expand Down
Loading