From 6179156867dcc7862fa93f01a9ecb73e8b79b5bd Mon Sep 17 00:00:00 2001 From: Adam Englander Date: Mon, 19 May 2025 14:25:26 -0400 Subject: [PATCH 1/2] Update contributing quick reference with uv-based instructions. --- content/contributing/quick.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/content/contributing/quick.md b/content/contributing/quick.md index a2f9d94..f7532fd 100644 --- a/content/contributing/quick.md +++ b/content/contributing/quick.md @@ -32,6 +32,11 @@ $ git switch -c short-descriptive-name ## Install Development Dependencies +Projects are being converted to use `uv`. The easy way to identify if that has occurred +is the existence, or not, of a `requirements` directory in root pf the project. + +### Projects with a `requirements` directory + Create a virtualenv and activate it. Install the dev dependencies, and the project in editable mode. Install the pre-commit hooks. @@ -60,6 +65,31 @@ Any time you open a new terminal, you need to activate the virtualenv again. If you've pulled from upstream recently, you can re-run the `pip` command above to get the current dev dependencies. + +### Projects without a `requirements` directory + +[Install `uv`] + +Run the `uv sync` command. + +[Install `uv`]: https://docs.astral.sh/uv/getting-started/installation/ + +Load the virtual environment (Mac and Linux): + +``` +$ . .venv/bin/activate +``` + +Load the virtualenv (Windows): + +``` +> .\.venv\Scripts\activate +``` + +Any time you open a new terminal, you need to activate the virtualenv again. If +you've pulled from upstream recently, you can re-run the `uv sync` command to +get the current dev dependencies. + ## Run Tests These are the essential test commands you can run while developing: From 68626c489212926a4cd3601dac9ffaa43ceba0d8 Mon Sep 17 00:00:00 2001 From: David Lord Date: Tue, 20 May 2025 11:34:37 -0400 Subject: [PATCH 2/2] Update quick.md --- content/contributing/quick.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/content/contributing/quick.md b/content/contributing/quick.md index f7532fd..ca88eff 100644 --- a/content/contributing/quick.md +++ b/content/contributing/quick.md @@ -68,19 +68,23 @@ get the current dev dependencies. ### Projects without a `requirements` directory -[Install `uv`] +[Install `uv`.][uv] -Run the `uv sync` command. +[uv]: https://docs.astral.sh/uv/getting-started/installation/ -[Install `uv`]: https://docs.astral.sh/uv/getting-started/installation/ +Install dev dependencies: -Load the virtual environment (Mac and Linux): +``` +$ uv sync +``` + +Activate the virtualenv (Mac and Linux): ``` $ . .venv/bin/activate ``` -Load the virtualenv (Windows): +Activate the virtualenv (Windows): ``` > .\.venv\Scripts\activate