Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,16 @@ py -m install -v -e .[dev]

# Post setup

You should prepare pre-commit, which will help you by checking that commits pass
You should prepare prek, which will help you by checking that commits pass
required checks:

```bash
pip install pre-commit # or brew install pre-commit on macOS
pre-commit install # Will install a pre-commit hook into the git repo
pip install prek # or brew install prek on macOS
prek install # Will install a pre-commit hook into the git repo
```

You can also/alternatively run `pre-commit run` (changes only) or
`pre-commit run --all-files` to check even without installing the hook.
You can also/alternatively run `prek run` (changes only) or
`prek run --all-files` to check even without installing the hook.

# Testing

Expand Down Expand Up @@ -90,12 +90,12 @@ nox -s docs -- --serve

# Pre-commit

This project uses pre-commit for all style checking. While you can run it with
nox, this is such an important tool that it deserves to be installed on its own.
Install pre-commit and run:
This project uses prek for all style checking. While you can run it with nox,
this is such an important tool that it deserves to be installed on its own.
Install prek and run:
Comment thread
nstarman marked this conversation as resolved.

```bash
pre-commit run -a
prek run -a
```

to check all files.
5 changes: 0 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
ci:
autoupdate_commit_msg: "chore: update pre-commit hooks"
autofix_commit_msg: "style: pre-commit fixes"
autoupdate_schedule: "quarterly"

repos:
- repo: https://github.com/adamchainz/blacken-docs
rev: "1.19.1"
Expand Down
4 changes: 2 additions & 2 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ def lint(s: nox.Session, /) -> None:

@session(uv_groups=["lint"], reuse_venv=True)
def precommit(s: nox.Session, /) -> None:
"""Run pre-commit."""
s.run("pre-commit", "run", "--all-files", *s.posargs)
"""Run prek."""
s.run("prek", "run", "--all-files", *s.posargs)
Comment thread
nstarman marked this conversation as resolved.


@session(uv_groups=["lint"], reuse_venv=True)
Expand Down
10 changes: 1 addition & 9 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,11 @@ dev = [
"ipykernel>=6.29.5",
"cz-conventional-gitmoji>=0.6.1",
{ include-group = "build" },
{ include-group = "docs" },
{ include-group = "lint" },
{ include-group = "nox" },
{ include-group = "test" },
]
docs = [
"furo>=2023.08.17",
"myst_parser>=0.13",
"sphinx>=7.0",
"sphinx-autodoc-typehints>=2.3.0",
"sphinx-copybutton>=0.5.2",
]
lint = ["mypy>=1.19.0", "pre-commit>=4.1.0", "pylint>=3.3.8"]
lint = ["mypy>=1.19.0", "prek>=0.4.9", "pylint>=3.3.8"]
nox = ["nox>=2024.10.9", "nox-uv>=0.6.3"]
test = [
"beartype>=0.19.0",
Expand Down
Loading
Loading