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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@ ipython_config.py
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# uv
uv.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

Expand Down
9 changes: 6 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.11.2
- repo: local
hooks:
- id: ruff

name: ruff
entry: uv run --extra dev ruff check --force-exclude
language: system
types_or: [python, pyi]
require_serial: true
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,11 +215,15 @@ To develop the package further:
```bash
pip install -e ".[dev]"
```
3. Install pre-commit hook
3. Install pre-commit hook. This requires [uv](https://docs.astral.sh/uv/), which the hook uses to run Ruff at the version pinned in `pyproject.toml`.
```bash
pre-commit install
```

### Linting

Ruff is pinned in `pyproject.toml`, which is the single source of truth for the pre-commit hook, CI, and local `ruff check .` runs. Ruff version bumps and their repo-wide application should get their own PRs so lint compliance can stay focused and intentional.

### Tests

To run all tests:
Expand Down
14 changes: 7 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,6 @@ dependencies = [
"pathspec"
]

[project.optional-dependencies]
dev = [
"pytest",
"ruff",
"pre-commit"
]

keywords = [
"checksum",
"md5",
Expand All @@ -44,6 +37,13 @@ keywords = [
"file-verification",
]

[project.optional-dependencies]
dev = [
"pytest",
"ruff==0.16.0",
"pre-commit"
]

[project.urls]
Homepage = "https://github.com/Imageomics/sum-buddy"
Repository = "https://github.com/Imageomics/sum-buddy.git"
Expand Down
Loading