formatting #21

.github/ISSUE_TEMPLATE/issue_template_bug.md

@@ -1,19 +1,19 @@
 ---
 name: Bug Issue
-about: For bugs and errors 
+about: For bugs and errors
 title: Your title should make sense if said after "The issue is <your issue title>"
 labels: "bug"
-assignees: ''
-
+assignees: ""
 ---
 
 ## Description of the issue
 
 Describe the problem in as much detail as possible.
-Focus on the expected and current behavior. 
+Focus on the expected and current behavior.
 If necessary, create a screenshot and insert below.
 
 ## Steps to Reproduce
+
 1.
 2.
 3.
@@ -23,9 +23,11 @@ If necessary, create a screenshot and insert below.
 Describe possible ideas for solution and evaluate advantages and disadvantages.
 
 ## Context and Environment
-* Version used: 
-* Operating system: 
-* Environment setup and (python) version: 
+
+- Version used:
+- Operating system:
+- Environment setup and (python) version:
 
 ## Workflow checklist
+
 - [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md)

.github/ISSUE_TEMPLATE/issue_template_feature.md

@@ -3,17 +3,17 @@ name: Feature Issue
 about: For new ideas, developments and features
 title: Your title should make sense if said after "The issue is <your issue title>"
 labels: "enhancement"
-assignees: ''
-
+assignees: ""
 ---
 
 ## Description of the issue
 
-Describe the problem in as much detail as possible. 
+Describe the problem in as much detail as possible.
 
 ## Ideas of solution
 
 Describe possible ideas for solution and evaluate advantages and disadvantages.
 
 ## Workflow checklist
+
 - [ ] I am aware of the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md)

.github/ISSUE_TEMPLATE/issue_template_release.md

@@ -3,13 +3,12 @@ name: Release Issue
 about: For a new release
 title: Release - Minor Version - 0.1.0
 labels: "enhancement"
-assignees: 'Ludee'
-
+assignees: "Ludee"
 ---
 
 ## Description of the release
 
-Describe the release in as much detail as possible. 
+Describe the release in as much detail as possible.
 
 ## Details of the release
 
@@ -19,6 +18,7 @@ Describe the release in as much detail as possible.
 **Date:** Arrange a convenient date
 
 ## Workflow checklist
+
 - [ ] I am aware of the workflow in [RELEASE_PROCEDURE.md](https://github.com/rl-institut/super-repo/blob/production/RELEASE_PROCEDURE.md)
 - [ ] 4. 🐙 Create a `Draft GitHub Release`
 - [ ] 5. 💠 Create a `release` branch

.github/pull_request_template.md

@@ -5,25 +5,30 @@ Describe the findings of the discussion in the issue or meeting.
 ## Type of change (CHANGELOG.md)
 
 ### Added
+
 - Add a new class [(#)](https://github.com/rl-institut/super-repo/pull/)
 
 ### Changed
+
 - Update a definition [(#)](https://github.com/rl-institut/super-repo/pull/)
 
 ### Removed
-- Remove a broken link [(#)](https://github.com/rl-institut/super-repo/pull/)
 
+- Remove a broken link [(#)](https://github.com/rl-institut/super-repo/pull/)
 
 ## Workflow checklist
 
 ### Automation
+
 Closes #
 
 ### PR-Assignee
+
 - [ ] 🐙 Follow the workflow in [CONTRIBUTING.md](https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md)
 - [ ] 📝 Update the [CHANGELOG.md](https://github.com/rl-institut/super-repo/blob/develop/CHANGELOG.md)
 - [ ] 📙 Update the documentation
 
 ### Reviewer
+
 - [ ] 🐙 Follow the [Reviewer Guidelines](https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md#40-let-someone-else-review-your-pr)
 - [ ] 🐙 Provided feedback and show sufficient appreciation for the work done

.github/workflows/gh-pages.yml

@@ -1,8 +1,8 @@
-name: gh-pages
+name: gh-pages (develop branch)
 on:
   push:
     branches:
-      - production
+      - develop
 permissions:
   contents: write
 jobs:
@@ -18,4 +18,4 @@ jobs:
           key: ${{ github.ref }}
           path: .cache
       - run: pip install --upgrade -r requirements.txt
-      - run: mkdocs gh-deploy --force
+      - run: mike deploy develop --push

.pre-commit-config.yaml

@@ -0,0 +1,72 @@
+# exclude webdevelopement build artefacts
+exclude: ^.*(.min.js|.min.css)$
+
+repos:
+  # Pre-commit-hooks - Out-of-the-box hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: check-json
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: pretty-format-json
+        args:
+          [
+            "--autofix", # Autofix JSONs
+          ]
+      - id: check-added-large-files
+        args: [ "--maxkb=1500" ]
+
+  # Black - Python code formatter
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+    - id: black
+
+  # isort - Sort Python imports
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+    - id: isort
+      args: ["--profile", "black", "--filter-files"]
+
+  # Ruff - Fast Python linter, written in Rust
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.0.284'
+    hooks:
+    - id: ruff
+
+  # Flake8 - Python linter with PyFlakes and pycodestyle
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+    - id: flake8
+      args: ["--max-line-length=88", "--ignore=E20,W503,W605"] # black compatible
+
+  # mypy mirror - Added static types to Python (Python is dynamically typed)
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.5.1'
+    hooks:
+    - id: mypy
+      additional_dependencies:
+        - 'sqlalchemy'
+        - 'types-requests'
+
+  # mirrors-prettier - Formatting for other files then python scripts
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: 'v3.0.2'
+    hooks:
+    - id: prettier
+      files: \.(css|less|md|json|sql)$
+
+  # Linter for JavaScript
+  # - repo: https://github.com/pre-commit/mirrors-eslint
+  #   rev: v8.38.0
+  #   hooks:
+  #     - id: eslint
+  #       additional_dependencies:
+  #       - eslint@8.14.0
+  #       - eslint-config-google@0.14.0
+  #       - eslint-plugin-jsdoc@39.2.9
+  #       args: ["--fix"]

CHANGELOG.md

@@ -6,29 +6,51 @@ For each version, important additions, changes and removals are listed here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Add a favicon for the documentation [(54#)](https://github.com/rl-institut/super-repo/pull/54)
+- Add a warning for older versions that links to latest [(#54)](https://github.com/rl-institut/super-repo/pull/54)
+- Add pre-commit and setup pre-commit-hooks [(#56)](https://github.com/rl-institut/super-repo/pull/56)
+- Add a community chat on Element [(#59)](https://github.com/rl-institut/super-repo/pull/59)
+- Add documentation on the regular community meetings [(#60)](https://github.com/rl-institut/super-repo/pull/60)
+
+### Changed
+
+- Update CSS to improve toc [(#54)](https://github.com/rl-institut/super-repo/pull/54)
+- Update documentation for mike [(#54)](https://github.com/rl-institut/super-repo/pull/54)
+- Update GitHub Action for develop branch [(#58)](https://github.com/rl-institut/super-repo/pull/58)
+
+### Removed
+
+- Disable GitHub Action for MkDocs Workflow [(#54)](https://github.com/rl-institut/super-repo/pull/54)
 
 ## [0.2.0] Minor Release - Oh Hi Mike - 2023-08-11
 
 ### Added
+
 - Add documentation version control with mike [(#47)](https://github.com/rl-institut/super-repo/pull/47)
 - Add CI-based automated testing and linting on commit and pull requests to"production" and "develop" branch. [(#55)](https://github.com/rl-institut/super-repo/pull/55)
 
 ### Changed
-- Update issue templates and release procedure [(#47)](https://github.com/rl-institut/super-repo/pull/47)
 
+- Update issue templates and release procedure [(#47)](https://github.com/rl-institut/super-repo/pull/47)
 
 ## [0.1.1] Patch Release - Emmy Hennings Day Patch - 2023-08-10
 
 ### Added
+
 - Add issue template for release `issue_template_release.md` [(#43)](https://github.com/rl-institut/super-repo/pull/43)
 
 ### Changed
-- Update the release procedure [(#43)](https://github.com/rl-institut/super-repo/pull/43)
 
+- Update the release procedure [(#43)](https://github.com/rl-institut/super-repo/pull/43)
 
 ## [0.1.0] Minor Release - Emmy Hennings Day - 2023-08-10
 
 ### Added
+
 - [LICENSE.txt](https://github.com/rl-institut/super-repo/blob/main/LICENSE.txt)
 - CITATION.cff [(#2)](https://github.com/rl-institut/super-repo/pull/2)
 - CONTRIBUTING.md [(#2)](https://github.com/rl-institut/super-repo/pull/2)
@@ -47,16 +69,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add `RELEASE_PROCEDURE.md` [(#37)](https://github.com/rl-institut/super-repo/pull/37)
 
 ### Changed
+
 - Update the .gitignore [(#19)](https://github.com/rl-institut/super-repo/pull/19)
 - Update the documentation file structure [(#28)](https://github.com/rl-institut/super-repo/pull/28)
 
 ### Removed
-- Remove the `src` folder [(#26)](https://github.com/rl-institut/super-repo/pull/26)
 
+- Remove the `src` folder [(#26)](https://github.com/rl-institut/super-repo/pull/26)
 
 ## [0.0.0] Initial Release - Hello Super-Repo - 2022-03-03
 
 ### Added
+
 - GitHub repository
 - .gitignore
 - LICENSE (MIT License)

CITATION.cff

@@ -10,6 +10,6 @@ title: "Super Repo"
 type: software
 license: MIT
 version: 0.2.0
-doi: 
+doi:
 date-released: 2023-08-11
-url: "https://github.com/rl-institut/super-repo/"
+url: "https://github.com/rl-institut/super-repo/"

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
+- Focusing on what is best not just for us as individuals, but for the overall
   community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or advances of
+- The use of sexualized language or imagery, and sexual attention or advances of
   any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
   without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities