Merge pull request #4 from c-p-schmidt/add-first-checks

First checks are added based on fourcipp

Author: c-p-schmidt

.github/workflows/check_code.yaml

@@ -0,0 +1,42 @@
+name: Code quality
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  fourc-webviewer-code-check:
+    name: Code check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up virtual environment
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-update-conda: true
+          conda-remove-defaults: true
+          activate-environment: 4c-webviewer
+          python-version: 3.12
+      - name: Install requirements
+        shell: bash -el {0}
+        run: |
+          conda activate 4c-webviewer
+          pip install -e .
+          pip install pre-commit
+      - name: Run code-checks
+        shell: bash -el {0}
+        run: |
+          conda activate 4c-webviewer
+          if [ "${GITHUB_REF}" = "refs/heads/main" ]; then
+            SKIP=no-commit-to-branch pre-commit run --all-files
+          else
+            pre-commit run --all-files
+          fi

.gitignore

@@ -157,4 +157,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/

.pre-commit-config.yaml

@@ -0,0 +1,74 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+        name: Check for added large files
+      - id: check-ast
+        name: Check Python files for parse errors
+      - id: check-case-conflict
+        name: Check files for case conflicts on case-insensitive filesystems
+      - id: check-docstring-first
+        name: Check that no code is placed prior to docstrings
+      - id: check-merge-conflict
+        name: Check for files that contain merge conflict strings
+      - id: check-toml
+        name: Check valid TOML syntax
+      - id: check-yaml
+        name: Check valid YAML syntax
+      - id: end-of-file-fixer
+        name: Check for newline at end of file
+        exclude: '^LICENSE$'
+      - id: debug-statements
+        name: Check for debugger imports
+      - id: trailing-whitespace
+        name: Check for trailing whitespaces
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.8.3
+    hooks:
+      - id: bandit
+        name: Run bandit (security linter for python)
+        args: ["-c", "pyproject.toml", "-r", "-ll", "src/fourc_webviewer/", "tests/"]
+        additional_dependencies: ["bandit[toml]"]
+  - repo: https://github.com/PyCQA/docformatter
+    rev: "eb1df347edd128b30cd3368dddc3aa65edcfac38" # change back to version once bug is fixed in latest version to be compatible with pre-commit
+    hooks:
+      - id: docformatter
+        name: Run docformatter (formatter for docstrings)
+        args: ["--in-place", "--config=./pyproject.toml", "-r", "src/fourc_webviewer/", "test/"]
+  - repo: https://github.com/econchick/interrogate
+    rev: 1.7.0
+    hooks:
+      - id: interrogate
+        name: Run interrogate (linter for docstrings)
+        args: [--fail-under=100, --ignore-init-module, --style=google, -vv]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        name: Run mypy (static type checker for python)
+        args: ["--install-types", "--non-interactive", "--ignore-missing-imports", "--follow-imports=silent"]
+  - repo: https://github.com/asmeurer/removestar
+    rev: "1.5.2"
+    hooks:
+      - id: removestar
+        name: Run removestar (remove wildcard imports)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.1
+    hooks:
+      - id: ruff # linter
+        name: Run ruff (linter for Python)
+        args: ["--fix", "--select", "I,TID252"] # "I => sort imports, TID252 => ban relative imports
+      - id: ruff-format # formatter
+        name: Run ruff (formatter for Python)
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.30.2
+    hooks:
+      - id: typos
+        name: Run typo checker
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.16.0
+    hooks:
+      - id: yamlfmt
+        name: Run yamlfmt
+        args: ["-formatter", "retain_line_breaks_single=true"]

README.md

@@ -82,4 +82,4 @@ We encourage you to test the current state and provide feedback on what function
 
 ## License
 
-This project is licensed under a MIT license. For further information check [`LICENSE`](./LICENSE).
+This project is licensed under a MIT license. For further information check [`LICENSE`](./LICENSE).

images/4C-logo/negative-white/4C-logo-landscape_negative.svg

@@ -0,0 +1 @@
+"""Module to initialize and run the webviewer application."""