From 26dc81fc6d85c676e4c7f2c74b0ff04500ad8f84 Mon Sep 17 00:00:00 2001 From: "Celestial.y" Date: Wed, 8 Oct 2025 22:51:59 +0800 Subject: [PATCH] Update scriptdata/uv/README.md --- scriptdata/uv/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/scriptdata/uv/README.md b/scriptdata/uv/README.md index dab4579cd..6ea05938a 100644 --- a/scriptdata/uv/README.md +++ b/scriptdata/uv/README.md @@ -6,10 +6,13 @@ This is important because there has been so many complaints about the failure in ## How to add/remove python package? 1. Edit `requirements.in`. You may refer to [PyPI](https://pypi.org/) for possible package names. - - See also [uv doc](https://docs.astral.sh/uv/pip/dependencies/#using-requirementsin). -2. Run `uv pip compile requirements.in -o requirements.txt` in this folder.[^1] +2. Run `uv pip compile requirements.in -o requirements.txt` in this folder. -[^1]: `requirements.txt` is included in git repo. It's for locking package versions to enhance stability and reproducibility. In fact, including package version lock file in git repo is also common in other places, for example the `package-lock.json` of Node.js projects. See [this stackoverflow question](https://stackoverflow.com/questions/48524417/should-the-package-lock-json-file-be-added-to-gitignore) for a deeper explanation. +**Notes:** +- See also [uv doc](https://docs.astral.sh/uv/pip/dependencies/#using-requirementsin). +- `requirements.txt` is included in git repo. It's for locking package versions to enhance stability and reproducibility. + - In fact, including package version lock file in git repo is also common in other places, for example the `package-lock.json` of Node.js projects (see also [this stackoverflow question](https://stackoverflow.com/questions/48524417/should-the-package-lock-json-file-be-added-to-gitignore)). + - However, it's not always recommended to include package version lock file in Git, for example [the poetry document](https://python-poetry.org/docs/basic-usage/#committing-your-poetrylock-file-to-version-control) recommend application developers to include package version lock file in Git, but library developers should consider more, such as not inluding the lock file or including it but refreshing regularly. ## How will the python packages get installed?