Add pre-commit

Author: lirsacc

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.10
+    hooks:
+      - id: ruff
+      - id: ruff-format
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: mypy
+        language: system
+        types: [ python ]
+        pass_filenames: true

README.md

@@ -72,3 +72,7 @@ you can install all development dependencies through
     $ pip install -r requirements-dev.txt
 
 After which all tools (`ruff`, `isort`, `pytest`, etc.) will be available.
+
+### pre-commit
+
+If this suits your workflow, you can install the pre-commit configuration using `pre-commit install` which will automatically check some things before allowing you to commit (`pre-commit` is included in the dev dependencies).

docs/source/conf.py

@@ -4,8 +4,13 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-import importlib.metadata
+# isort: skip_file
+# mypy: ignore-errors
+# ruff: noqa
+
 import datetime
+import importlib.metadata
+
 
 # -- Path setup --------------------------------------------------------------
 

pyproject.toml

@@ -152,6 +152,10 @@ unfixable = [
     "B", # Avoid trying to fix flake8-bugbear (`B`) violations.
 ]
 
+exclude = [
+    "docs/**/*.py",
+]
+
 [tool.ruff.lint.pydocstyle]
 convention = "pep257"