Merge pull request #288 from AndreWohnsland/dev

add pre commit hooks

Author: AndreWohnsland

.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+---
+default_install_hook_types:
+  - commit-msg
+  - pre-commit
+  - pre-push
+exclude: ^(.*(\.?venv.*)/)
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-format
+        name: ☕️ Use Ruff to format code
+        language: system
+        types: [python]
+        entry: uv run ruff format
+        require_serial: true
+      - id: ruff-linting
+        name: ☕️ Use Ruff to lint code
+        language: system
+        types: [python]
+        entry: uv run ruff check --fix
+        require_serial: true
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-json
+        name: ☕️ Check for JSON syntax errors
+  - repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.10.0
+    hooks:
+      - id: shellcheck
+        name: ☕️ Ensure Shell Scripts are good with ShellCheck
+        files: .*\.sh$
+        args: [-x]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        name: ☕️ Ensure types are correct with mypy
+        args:
+          - '--config-file=pyproject.toml'
+          - '--python-version=3.11'
+        additional_dependencies:
+          - types-pyyaml>=6.0.12
+          - types-requests>=2.32.0
+        pass_filenames: false

pyproject.toml

@@ -41,10 +41,11 @@ dev-dependencies = [
     "ruff>=0.9.1",
     "mkdocs-material>=9.5.49",
     "mkdocs>=1.6.1",
-    "mypy>=1.14.1",
+    "mypy>=1.15.0",
     "ipykernel>=6.29.5",
     "pytest>=8.3.4",
     "pytest-cov>=6.0.0",
+    "pre-commit>=4.2.0",
 ]
 # This is a workaround for the missing support of aarch64 in pyqt5, need to install this over apt +
 # include this with system site packages

readme.md

@@ -150,6 +150,13 @@ See also at the [dev notes](./docs/.devnotes.md) section for a complete run down
 uv sync --all-extras
 ```
 
+We also use pre-commits to check the code style and run some tests before every commit.
+You can install them with:
+
+```bash
+uv run pre-commit install --install-hooks
+```
+
 This will install all dependencies and you can start developing.
 Then just run: