From 8039ace5ca9a9e4bc1466c8ab3c18888264ebeab Mon Sep 17 00:00:00 2001 From: Nathan Weinberg Date: Mon, 10 Mar 2025 11:13:01 -0400 Subject: [PATCH] docs: update CONTRIBUTING.md with additional guidance around `uv` Signed-off-by: Nathan Weinberg --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c0b5d94e..71e610064 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,6 +61,7 @@ outlined on that page and do not file a public issue. We use [uv](https://github.com/astral-sh/uv) to manage python dependencies and virtual environments. You can install `uv` by following this [guide](https://docs.astral.sh/uv/getting-started/installation/). + You can install the dependencies by running: ```bash @@ -70,6 +71,11 @@ uv pip install -e . source .venv/bin/activate ``` +> [!NOTE] +> You can pin a specific version of Python to use for `uv` by adding a `.python-version` file in the root project directory. +> Otherwise, `uv` will automatically select a Python version according to the `requires-python` section of the `pyproject.toml`. +> For more info, see the [uv docs around Python versions](https://docs.astral.sh/uv/concepts/python-versions/). + Note that you can create a dotenv file `.env` that includes necessary environment variables: ``` LLAMA_STACK_BASE_URL=http://localhost:8321