diff --git a/docs/pages/virtual.md b/docs/pages/virtual.md index f0c5aaa8..7d2e1335 100644 --- a/docs/pages/virtual.md +++ b/docs/pages/virtual.md @@ -5,16 +5,16 @@ layout: default ## Virtual environments -| Name | Short description | 🚦 | -| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------: | -| conda-forge [miniforge] | Installs, runs, and updates packages and their dependencies. Uses `conda`, but with community maintained packages from `conda-forge` channel instead of commercially maintained packages. | Best | -| [uv] | Fast dependency (and project) management tool. A drop-in replacement for `venv`. This will probably become our Best tool, but for now we are playing cautious as there are some open bugs and features. If you're comfortable using `venv` syntax we'd recommend this. | Good | -| [pipenv] | Automatically creates and manages a virtualenv for your projects. | Good | -| [pixi] | A fast drop-in replacement for `conda`. | Good | -| [pyenv] | Lets you easily switch between multiple versions of Python. | Good | -| [virtualenv] | Creates isolated Python environments, and offers more features than venv. | Good | -| [venv] | Creates isolated Python environments. Fewer features than other tools, but very widely used and comes built into Python. | Good | -| [anaconda] | Due to recent [licensing ambiguity][anaconda-problems], we recommend avoiding anaconda and many of the default channels. We recommend installing miniforge and sticking to the `conda-forge` channel. | Avoid | +| Name | Short description | 🚦 | +| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------: | +| [uv] | Fast dependency (and project) management tool. A drop-in replacement for `venv` with additional features including easy management of multiple Python versions. | Best | +| conda-forge [miniforge] | Installs, runs, and updates packages and their dependencies. Uses `conda`, but with community maintained packages from `conda-forge` channel instead of commercially maintained packages. | Good | +| [pipenv] | Automatically creates and manages a virtualenv for your projects. | Good | +| [pixi] | A fast drop-in replacement for `conda`. | Good | +| [pyenv] | Lets you easily switch between multiple versions of Python. | Good | +| [virtualenv] | Creates isolated Python environments, and offers more features than venv. | Good | +| [venv] | Creates isolated Python environments. Fewer features than other tools, but very widely used and comes built into Python. | Good | +| [anaconda] | Due to recent [licensing ambiguity][anaconda-problems], we recommend avoiding anaconda and many of the default channels. We recommend installing miniforge and sticking to the `conda-forge` channel. | Avoid | diff --git a/tests/data/test_package_generation/README.md b/tests/data/test_package_generation/README.md index a37415bb..32102cd9 100644 --- a/tests/data/test_package_generation/README.md +++ b/tests/data/test_package_generation/README.md @@ -57,12 +57,12 @@ Centre for Advanced Research Computing, University College London We recommend installing in a project specific virtual environment created using a environment management tool such as -[Conda](https://docs.conda.io/projects/conda/en/stable/). To install the latest -development version of `cookiecutter-test` using `pip` in the currently active +[uv](https://docs.astral.sh/uv/). To install the latest +development version of `cookiecutter-test` using `uv pip` in the currently active environment run ```sh -pip install git+https://github.com/test-user/cookiecutter-test.git +uv pip install git+https://github.com/test-user/cookiecutter-test.git ``` Alternatively create a local clone of the repository with @@ -74,7 +74,7 @@ git clone https://github.com/test-user/cookiecutter-test.git and then install in editable mode by running ```sh -pip install -e . +uv pip install -e . ``` ### Running Locally @@ -112,7 +112,7 @@ from the root of the repository. The built documentation will be written to `site`. Alternatively to build and preview the documentation locally, in a Python -environment with the optional `docs` dependencies installed, run +environment with the `docs` dependency group installed, run ```sh mkdocs serve diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index f7edbf5c..53e0cfd7 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -63,12 +63,12 @@ Centre for Advanced Research Computing, University College London We recommend installing in a project specific virtual environment created using a environment management tool such as -[Conda](https://docs.conda.io/projects/conda/en/stable/). To install the latest -development version of `{{cookiecutter.project_slug}}` using `pip` in the currently active +[uv](https://docs.astral.sh/uv/). To install the latest +development version of `{{cookiecutter.project_slug}}` using `uv pip` in the currently active environment run ```sh -pip install git+{{cookiecutter.__repo_url}}.git +uv pip install git+{{cookiecutter.__repo_url}}.git ``` Alternatively create a local clone of the repository with @@ -80,7 +80,7 @@ git clone {{cookiecutter.__repo_url}}.git and then install in editable mode by running ```sh -pip install -e . +uv pip install -e . ``` ### Running Locally @@ -118,7 +118,7 @@ from the root of the repository. The built documentation will be written to `site`. Alternatively to build and preview the documentation locally, in a Python -environment with the optional `docs` dependencies installed, run +environment with the `docs` dependency group installed, run ```sh mkdocs serve