From 679af4f0994ce6b84d8e8c6036a1a338c1e50898 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C5=A0oltis?= Date: Tue, 7 Jan 2025 12:32:39 +0100 Subject: [PATCH] pip: Update docs about using pip_find_build_deps script MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit + remove old links to Cachito repository Signed-off-by: Michal Ĺ oltis --- docs/pip.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/docs/pip.md b/docs/pip.md index 5ed4a956e..439f77d8c 100644 --- a/docs/pip.md +++ b/docs/pip.md @@ -432,16 +432,11 @@ but contains build dependencies rather than runtime dependencies. *Note: this file must contain all the transitive build dependencies of each of your transitive runtime dependencies (you are installing dependencies from source).* -There's no great way to generate such a file. As far as we know, the best solution is pip-compile combined with this -standalone script that lives in the old Cachito repo: -[pip\_find\_builddeps.py](https://github.com/containerbuildsystem/cachito/blob/master/bin/pip_find_builddeps.py). - -#### Prerequisites - -Generate a [fully resolved requirements.txt](#requirementstxt) - -Get the script ([download](https://raw.githubusercontent.com/containerbuildsystem/cachito/master/bin/pip_find_builddeps.py) -directly from Github, it has no runtime dependencies other than pip) +There's no great way to generate such a file. Together with pip-compile, you can use the +[hack/pip\_find\_build_deps.py](https://github.com/containerbuildsystem/cachi2/blob/main/hack/pip_find_build_deps.py) +script if you already have our repository cloned. If not then you can download the script directly from Github +[here](https://raw.githubusercontent.com/containerbuildsystem/cachi2/main/hack/pip_find_build_deps.py) +(it has no runtime dependencies other than pip). If your project itself has build dependencies (typically defined in pyproject.toml), copy them to `requirements-build.in`. @@ -466,10 +461,10 @@ pdm-pep517 **Usage:** -Run the `pip_find_builddeps.py` script and pip-compile the output: +Run the `pip_find_build_deps.py` script and pip-compile the output: ```shell -pip_find_builddeps.py requirements.txt \ +pip_find_build_deps.py requirements.txt \ --append \ --only-write-on-update \ -o requirements-build.in