From da8efd36d7b7d3ba03eed08c81b34731084b2836 Mon Sep 17 00:00:00 2001 From: Maxime Beauchemin Date: Fri, 6 Jun 2025 16:30:27 -0700 Subject: [PATCH] docs: clarify how `requirements/` should be modified (#33714) --- requirements/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 requirements/README.md diff --git a/requirements/README.md b/requirements/README.md new file mode 100644 index 00000000000..29192a1fad3 --- /dev/null +++ b/requirements/README.md @@ -0,0 +1,13 @@ +## Python dependency logic + +In this folder, the `.in` files, in conjunction with the `../pyproject.toml` file (in the root of the repo) are used to generate the pinned requirements as `.txt` files. + +To alter the pinned dependency, you can edit/alter the `.in` and `pyproject.toml` files, and then run the following command: + +```bash +./scripts/uv-pip-compile.sh +``` + +This will generate the pinned requirements in the `.txt` files, which will be used in our CI/CD pipelines and in the Docker images. + +We recommend to everyone in the community to use the pinned requirements in their local development environments, to ensure consistency across different environments, though we don't force requirements as part of our python package semantics to allow flexibility for users to install different versions of the dependencies if they wish.