From 1ed5aabe54c2951487828221ea8258b1219df3c2 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Thu, 5 Sep 2024 09:24:54 +0100 Subject: [PATCH 1/5] =?UTF-8?q?conda=20=E2=86=92=20miniforge.=20Make=20ana?= =?UTF-8?q?conda=20explicitly=20red.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Solves #443. Deliberately does not address #419. Even if we decide to recommend `uv` over `conda-forge` we want to make the distinction. --- docs/pages/virtual.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/pages/virtual.md b/docs/pages/virtual.md index 6e189cb1..3d982f94 100644 --- a/docs/pages/virtual.md +++ b/docs/pages/virtual.md @@ -5,10 +5,13 @@ layout: default # Virtual environments -| Name | Short description | 🚦 | -| -------------------------------------------------------- | ------------------------------------------------------------------------- | :-: | -| [Conda](https://docs.conda.io/projects/conda/en/stable/) | Installs, runs, and updates packages and their dependencies. | 🟒 | -| [pipenv](https://pipenv.pypa.io/en/latest/) | Automatically creates and manages a virtualenv for your projects. | 🟠 | -| [pyenv](https://github.com/pyenv/pyenv) | Lets you easily switch between multiple versions of Python. | 🟠 | -| [virtualenv](https://virtualenv.pypa.io/en/latest/) | Creates isolated Python environments, and offers more features than venv. | 🟠 | -| [venv](https://docs.python.org/3/library/venv.html) | Creates isolated Python environments. | πŸ”΄ | +| Name | Short description | 🚦 | +| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-: | +| [conda-forge miniforge](https://github.com/conda-forge/miniforge) | Installs, runs, and updates packages and their dependencies. A trusted sub-set of `conda` with the `conda-forge` channel. | 🟒 | +| [pipenv](https://pipenv.pypa.io/en/latest/) | Automatically creates and manages a virtualenv for your projects. | 🟠 | +| [pyenv](https://github.com/pyenv/pyenv) | Lets you easily switch between multiple versions of Python. | 🟠 | +| [virtualenv](https://virtualenv.pypa.io/en/latest/) | Creates isolated Python environments, and offers more features than venv. | 🟠 | +| [venv](https://docs.python.org/3/library/venv.html) | Creates isolated Python environments. | πŸ”΄ | +| [anaconda](https://www.anaconda.com/) | Due to recent [licensing ambiguity][anaconda-problems], we recommend avoiding anaconda and many of the default channels. We recommend miniforge or sticking to the `conda-forge` channel. | πŸ”΄ | + +[anaconda-problems]: https://www.theregister.com/2024/08/08/anaconda_puts_the_squeeze_on/ From ef14bd7723c30ff11c09bf5cdeecce123f1f3b07 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Thu, 5 Sep 2024 09:47:32 +0100 Subject: [PATCH 2/5] Move all links to end of file for consistency. --- docs/pages/virtual.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/pages/virtual.md b/docs/pages/virtual.md index 3d982f94..87f7739b 100644 --- a/docs/pages/virtual.md +++ b/docs/pages/virtual.md @@ -5,13 +5,21 @@ layout: default # Virtual environments -| Name | Short description | 🚦 | -| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-: | -| [conda-forge miniforge](https://github.com/conda-forge/miniforge) | Installs, runs, and updates packages and their dependencies. A trusted sub-set of `conda` with the `conda-forge` channel. | 🟒 | -| [pipenv](https://pipenv.pypa.io/en/latest/) | Automatically creates and manages a virtualenv for your projects. | 🟠 | -| [pyenv](https://github.com/pyenv/pyenv) | Lets you easily switch between multiple versions of Python. | 🟠 | -| [virtualenv](https://virtualenv.pypa.io/en/latest/) | Creates isolated Python environments, and offers more features than venv. | 🟠 | -| [venv](https://docs.python.org/3/library/venv.html) | Creates isolated Python environments. | πŸ”΄ | -| [anaconda](https://www.anaconda.com/) | Due to recent [licensing ambiguity][anaconda-problems], we recommend avoiding anaconda and many of the default channels. We recommend miniforge or sticking to the `conda-forge` channel. | πŸ”΄ | +| Name | Short description | 🚦 | +| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-: | +| conda-forge [miniforge] | Installs, runs, and updates packages and their dependencies. A trusted sub-set of `conda` with the `conda-forge` channel. | 🟒 | +| [pipenv] | Automatically creates and manages a virtualenv for your projects. | 🟠 | +| [pyenv] | Lets you easily switch between multiple versions of Python. | 🟠 | +| [virtualenv] | Creates isolated Python environments, and offers more features than venv. | 🟠 | +| [anaconda] | Due to recent [licensing ambiguity][anaconda-problems], we recommend avoiding anaconda and many of the default channels. We recommend miniforge or sticking to the `conda-forge` channel. | πŸ”΄ | +| [venv] | Creates isolated Python environments. | πŸ”΄ | + + +[miniforge]: https://github.com/conda-forge/miniforge +[pipenv]: https://pipenv.pypa.io/en/latest/ +[pyenv]: https://github.com/pyenv/pyenv +[virtualenv]: https://virtualenv.pypa.io/en/latest/ +[anaconda]: https://www.anaconda.com/ [anaconda-problems]: https://www.theregister.com/2024/08/08/anaconda_puts_the_squeeze_on/ +[venv]: https://commons.wikimedia.org/wiki/File:Devops-toolchain.svg From 7c13be6b52615c90481ea6170e321422845ee76c Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Thu, 5 Sep 2024 10:54:46 +0100 Subject: [PATCH 3/5] Improvements from code review Co-authored-by: David Stansby --- docs/pages/virtual.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/virtual.md b/docs/pages/virtual.md index 87f7739b..434ffbe7 100644 --- a/docs/pages/virtual.md +++ b/docs/pages/virtual.md @@ -11,12 +11,12 @@ layout: default | [pipenv] | Automatically creates and manages a virtualenv for your projects. | 🟠 | | [pyenv] | Lets you easily switch between multiple versions of Python. | 🟠 | | [virtualenv] | Creates isolated Python environments, and offers more features than venv. | 🟠 | -| [anaconda] | Due to recent [licensing ambiguity][anaconda-problems], we recommend avoiding anaconda and many of the default channels. We recommend miniforge or sticking to the `conda-forge` channel. | πŸ”΄ | +| [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. | πŸ”΄ | | [venv] | Creates isolated Python environments. | πŸ”΄ | -[miniforge]: https://github.com/conda-forge/miniforge +[miniforge]: https://conda-forge.org/download/ [pipenv]: https://pipenv.pypa.io/en/latest/ [pyenv]: https://github.com/pyenv/pyenv [virtualenv]: https://virtualenv.pypa.io/en/latest/ From 1f8eb6baae09568408facd333457aa5f74b2a13f Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Thu, 5 Sep 2024 10:56:58 +0100 Subject: [PATCH 4/5] Tweak to the miniforge description. Co-authored-by: David Stansby --- docs/pages/virtual.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/pages/virtual.md b/docs/pages/virtual.md index 434ffbe7..2759e2a7 100644 --- a/docs/pages/virtual.md +++ b/docs/pages/virtual.md @@ -5,14 +5,14 @@ layout: default # Virtual environments -| Name | Short description | 🚦 | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-: | -| conda-forge [miniforge] | Installs, runs, and updates packages and their dependencies. A trusted sub-set of `conda` with the `conda-forge` channel. | 🟒 | -| [pipenv] | Automatically creates and manages a virtualenv for your projects. | 🟠 | -| [pyenv] | Lets you easily switch between multiple versions of Python. | 🟠 | -| [virtualenv] | Creates isolated Python environments, and offers more features than venv. | 🟠 | +| 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. | 🟒 | +| [pipenv] | Automatically creates and manages a virtualenv for your projects. | 🟠 | +| [pyenv] | Lets you easily switch between multiple versions of Python. | 🟠 | +| [virtualenv] | Creates isolated Python environments, and offers more features than venv. | 🟠 | | [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. | πŸ”΄ | -| [venv] | Creates isolated Python environments. | πŸ”΄ | +| [venv] | Creates isolated Python environments. | πŸ”΄ | From 9fa80f952aa77da41a3aba0db377a29ce60602d2 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Thu, 5 Sep 2024 11:50:50 +0100 Subject: [PATCH 5/5] Update docs/pages/virtual.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: David PΓ©rez-SuΓ‘rez --- docs/pages/virtual.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/virtual.md b/docs/pages/virtual.md index 2759e2a7..829cffdf 100644 --- a/docs/pages/virtual.md +++ b/docs/pages/virtual.md @@ -22,4 +22,4 @@ layout: default [virtualenv]: https://virtualenv.pypa.io/en/latest/ [anaconda]: https://www.anaconda.com/ [anaconda-problems]: https://www.theregister.com/2024/08/08/anaconda_puts_the_squeeze_on/ -[venv]: https://commons.wikimedia.org/wiki/File:Devops-toolchain.svg +[venv]: https://docs.python.org/3/library/venv.html