feat: Configure and run pre-commit hooks

Set up pre-commit hooks with the pre-commit Python package, enabling the
following, as well as running them manually for the first time on the
entire repository with 'pre-commit run --all-files':
- trailing-whitespace
- end-of-file-fixer
- check-yaml
- check-added-large-files
- check-json
- check-toml
- ruff
- ruff-format

Signed-off-by: Phoevos Kalemkeris <[email protected]>

Author: phoevos

.coveragerc

@@ -1,3 +1,3 @@
 [run]
 include = */app/*
-omit = */tests/*
+omit = */tests/*

.dockerignore

@@ -1,2 +1,2 @@
 **/app/model
-**/docker/*/.env*
+**/docker/*/.env*

.github/workflows/main.yaml

@@ -32,4 +32,4 @@ jobs:
         uses: astral-sh/ruff-action@v1
       - name: Test
         run: |
-          pytest --cov --cov-report=html:coverage_reports #--random-order 
+          pytest --cov --cov-report=html:coverage_reports #--random-order

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+default_install_hook_types:
+- pre-commit
+- post-checkout
+- post-merge
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-yaml
+  - id: check-added-large-files
+  - id: check-json
+  - id: check-toml
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.8.4
+  hooks:
+  - id: ruff
+    entry: ruff check --force-exclude --fix
+  - id: ruff-format
+    entry: ruff format --force-exclude

CONTRIBUTING.md

@@ -33,4 +33,4 @@ args=(sys.stdout,)
 format=%(asctime)s %(levelname)-6s [%(name)s$%(funcName)s] %(message)s
 
 [formatter_detailedFormatter]
-format=%(asctime)s %(levelname)-6s [%(name)s$%(funcName)s] %(message)s call_trace=%(pathname)s:%(lineno)-4d
+format=%(asctime)s %(levelname)-6s [%(name)s$%(funcName)s] %(message)s call_trace=%(pathname)s:%(lineno)-4d