Skip to content

Commit 54b2916

Browse files
committed
Recommend to install with pre-commit-uv
1 parent 3765a70 commit 54b2916

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ We assume that you have full internet access.
3232
uv is a tool to manage Python projects and for managing isolated Python-based applications.
3333
You will use it in your generated project to manage dependencies and build distribution files.
3434
Install uv by following their [instructions](https://docs.astral.sh/uv/getting-started/installation/).
35-
35+
3636
Note: Environments with private pypi repository may need extra configuration (example):
3737
`export UV_DEFAULT_INDEX=https://nexus.example.com/repository/pypi-all/simple`
3838

@@ -107,12 +107,14 @@ Included are [yamllint](https://github.com/adrienverge/yamllint) for consistent
107107
[ruff](https://docs.astral.sh/ruff/) for formatting and linting Python code and
108108
the spell checkers [codespell](https://github.com/codespell-project/codespell) and [typos](https://github.com/crate-ci/typos). To use this
109109

110-
* install pre-commit with: `uv tool install pre-commit`
110+
* install pre-commit with: `uv tool install pre-commit --with pre-commit-uv`
111111
* activate pre-commit in the project by running (at the root of the project): `pre-commit install`
112112

113113
Once installed pre-commit will perform the checks on every commit and reject a commit if errors are found;
114114
it will even auto-correct several types of errors.
115-
You can also run the pre-configured checks manually with `pre-commit run -a`.
115+
The installation with [pre-commit-uv](https://pypi.org/project/pre-commit-uv/) is optional but recommended as it accelearates the initial seed operation.
116+
117+
Alternatively you can run the pre-configured checks manually with `pre-commit run -a`.
116118

117119
### Step 4: Validate the schema
118120

0 commit comments

Comments
 (0)