Skip to content

Commit 10e15d5

Browse files
authored
📝 Update templated files
1 parent 892a1d6 commit 10e15d5

File tree

2 files changed

+41
-22
lines changed

2 files changed

+41
-22
lines changed

.github/renovate.json5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
},
5353
{
5454
description: "Group and automerge all patch updates",
55-
groupName: "patch updates",
55+
groupName: "patch versions",
5656
groupSlug: "all-patch",
5757
matchUpdateTypes: ["patch"],
5858
automerge: true

docs/installation.md

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -258,62 +258,80 @@ For detailed guidelines and workflows, see {doc}`contributing`.
258258

259259
Now you can make your changes locally.
260260

261-
4. Install development tools:
261+
4. Install the project and its development dependencies:
262262

263263
We highly recommend using modern, fast tooling for the development workflow.
264264
We recommend using [{code}`uv`][uv].
265265
If you don't have {code}`uv`, follow the installation instructions in the recommendation above (see {ref}`tip above <uv-recommendation>`).
266266
See the [uv documentation][uv] for more information.
267267

268-
We also recommend installing [{code}`pre-commit`][pre-commit] to automatically run checks before each commit and [{code}`nox`][nox] to automate common development tasks.
269-
270268
::::{tab-set}
271269
:sync-group: installer
272270

273271
:::{tab-item} {code}`uv` _(recommended)_
274272
:sync: uv
275-
The easiest way to install {code}`pre-commit` and {code}`nox` is via [{code}`uv`][uv]:
273+
Install the project (including development dependencies) with [{code}`uv`][uv]:
274+
275+
```console
276+
$ uv sync
277+
```
278+
279+
:::
280+
:::{tab-item} {code}`pip`
281+
:sync: pip
282+
If you really don't want to use [{code}`uv`][uv], you can install the project and the development dependencies into a virtual environment using {code}`pip`.
276283

277284
```console
278-
$ uv tool install pre-commit
279-
$ uv tool install nox
285+
$ python -m venv .venv
286+
$ source ./.venv/bin/activate
287+
(.venv) $ python -m pip install -U pip
288+
(.venv) $ python -m pip install -e . --group dev
280289
```
281290

282291
:::
283-
:::{tab-item} {code}`brew`
284-
:sync: brew
285-
On macOS with Homebrew, you can install {code}`pre-commit` and {code}`nox` with:
292+
::::
293+
294+
5. Install pre-commit hooks to ensure code quality:
295+
296+
The project uses [pre-commit] hooks for running linters and formatting tools on each commit.
297+
These checks can be run manually via [{code}`nox`][nox], by running:
298+
299+
```console
300+
$ nox -s lint
301+
```
302+
303+
They can also be run automatically on every commit via [{code}`prek`][prek] (recommended).
304+
To set this up, install {code}`prek`, e.g., via:
305+
306+
::::{tab-set}
307+
:::{tab-item} macOS and Linux
286308

287309
```console
288-
$ brew install pre-commit nox
310+
$ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/j178/prek/releases/latest/download/prek-installer.sh | sh
289311
```
290312

291313
:::
292-
:::{tab-item} {code}`pipx`
293-
:sync: pipx
294-
If you prefer to use [{code}`pipx`][pipx], you can install {code}`pre-commit` and {code}`nox` with:
314+
:::{tab-item} Windows
295315

296316
```console
297-
$ pipx install pre-commit
298-
$ pipx install nox
317+
$ powershell -ExecutionPolicy ByPass -c "irm https://github.com/j178/prek/releases/latest/download/prek-installer.ps1 | iex"
299318
```
300319

301320
:::
302-
:::{tab-item} {code}`pip`
303-
:sync: pip
304-
If you prefer to use regular {code}`pip` (preferably in a virtual environment), you can install {code}`pre-commit` and {code}`nox` with:
321+
322+
:::{tab-item} {code}`uv`
305323

306324
```console
307-
$ pip install pre-commit nox
325+
$ uv tool install prek
308326
```
309327

310328
:::
311329
::::
312330

313-
Then enable the {code}`pre-commit` hooks with:
331+
Then run:
314332

315333
```console
316-
$ pre-commit install
334+
$ prek install
317335
```
318336

319337
<!-- Links -->
@@ -323,5 +341,6 @@ For detailed guidelines and workflows, see {doc}`contributing`.
323341
[nox]: https://nox.thea.codes/en/stable/
324342
[pipx]: https://pypa.github.io/pipx/
325343
[pre-commit]: https://pre-commit.com/
344+
[prek]: https://prek.j178.dev
326345
[ruff]: https://docs.astral.sh/ruff/
327346
[uv]: https://docs.astral.sh/uv/

0 commit comments

Comments
 (0)