From e01022d75b14fc989b34cd3cfe9d4f1185e9ea01 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Tue, 9 Jul 2024 21:05:59 -0400 Subject: [PATCH] Add Python installation guide (#4942) Note some of this behavior does not exist yet. --- docs/guides/install-python.md | 58 +++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/docs/guides/install-python.md b/docs/guides/install-python.md index aa0f171a7de7..3e1e4bb04820 100644 --- a/docs/guides/install-python.md +++ b/docs/guides/install-python.md @@ -1 +1,59 @@ # Installing Python + +uv can manage Python installations — Python does not need to be installed to use uv. + +To install Python: + +```console +$ uv python install +``` + +This will install a uv-managed Python version even if there is already a Python installation on the system. + +Once Python is installed, it can be invoked via `python`: + +```console +$ python --version +``` + +To prevent uv from managing Python system-wide, provide the `--no-shim` option during installation. + +## Installing a specific version + +To install a specific Python version: + +```console +$ uv python install 3.12 +``` + +See the [Python toolchain](../preview/toolchains.md) documentation for more details. + +## Viewing Python installations + +To view available and installed Python versions: + +```console +$ uv python list +``` + +## Automatic Python downloads + +Note that Python does not need to be explicitly installed to use uv. By default, uv will automatically download Python versions when they are required. For example, the following would download Python 3.12 if it was not installed: + +```console +$ uv run --python 3.12 python -c 'print("hello world")' +``` + +Even if a specific Python version is not requested, uv will download the latest version on demand. For example, the following will create a new virtual environment and download a managed Python version if one hasn't been installed yet: + +```console +$ uv venv --python-preference only-managed +``` + +Note that when an automatic Python installation occurs, the `python` command will not be added to the shell. Use `uv python install-shim` to ensure the `python` shim is installed. + +## Using an existing Python installation + +uv will also use an existing Python installation if already present on the system. There's no configuration necessary for this behavior, uv will use the system Python if it satisfies the requirements of the command invocation. + +To force uv to use the system Python, provide the `--python-preference only-system` option.