Initial commit

.gitattributes

@@ -0,0 +1,24 @@
+# Default behaviour
+*               text=crlf
+
+# All text files are CRLF
+*.txt		    text eol=crlf
+*.h 		    text eol=crlf
+*.c 		    text eol=crlf
+*.cpp 		    text eol=crlf
+*.hpp 		    text eol=crlf
+*.py 		    text eol=crlf
+*.json 		    text eol=crlf
+*.md 		    text eol=crlf
+*.puml 		    text eol=crlf
+*.plantuml 		text eol=crlf
+*.ini 		    text eol=crlf
+*.bat 		    text eol=crlf
+*.yml 		    text eol=crlf
+*.toml 		    text eol=crlf
+*.cfg 		    text eol=crlf
+
+# Images should be treated as binary
+*.png           binary
+*.jpg           binary
+*.jepg          binary

.github/workflows/test.yml

@@ -0,0 +1,92 @@
+name: Test
+
+# Controls when the action will run.
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: [main]
+  release:
+    # A release, pre-release, or draft of a release is published.
+    types: [published]
+  # Allows you to run this workflow manually from the Actions tab.
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel.
+jobs:
+  # The introduction just shows some useful informations.
+  intro:
+    # The type of runner that the job will run on.
+    runs-on: ubuntu-latest
+    # Steps represent a sequence of tasks that will be executed as part of the job.
+    steps:
+      - run: echo "The job was automatically triggered by a ${{ github.event_name }} event."
+      - run: echo "The name of the branch is ${{ github.ref }} and the repository is ${{ github.repository }}."
+
+  lint:
+    # The type of runner that the job will run on.
+    runs-on: ubuntu-latest
+    needs: intro
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    # Steps represent a sequence of tasks that will be executed as part of the job.
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pylint toml
+          pip install .
+
+      - name: Analysing the code with pylint
+        run: |
+          pylint ./src
+
+  test:
+    # The type of runner that the job will run on.
+    runs-on: ubuntu-latest
+    needs: intro
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    # Steps represent a sequence of tasks that will be executed as part of the job.
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest pytest-cov toml
+          pip install .
+
+      - name: Test and create coverage report
+        run: |
+          pytest tests -v --cov=./src --cov-report=term
+  
+# Uncomment this section to generate a html coverage report
+#      - name: Test and create coverage report
+#        run: |
+#          pytest tests -v --cov=./src --cov-report=html:coverage_report
+#
+#      - name: Upload coverage report
+#        uses: actions/upload-artifact@v4
+#        with:
+#          name: coverage-report-${{ matrix.python-version }}
+#          path: coverage_report/

.gitignore

@@ -0,0 +1,175 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+_autosummary
+build/
+_build/
+_sw-architecture
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+_pylint.tmp
+pylint.rst
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Exported files
+*export*.json
+
+# Certificates
+*.pem
+*.crt
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  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/
+
+# Development Scripts
+dev/

.pylintrc

@@ -0,0 +1,40 @@
+# This Pylint rcfile contains a best-effort configuration to uphold the
+# best-practices and style described in the Google Python style guide.
+# some sections that should not be used, and some where the defautl value is ok, have been removed
+# For detailed documentation of all options see: https://pylint.pycqa.org/en/latest/user_guide/configuration/all-options.html
+#
+# The original file can be found here:
+#   https://google.github.io/styleguide/pyguide.html
+
+
+[MAIN]
+
+# Files or directories to be skipped. They should be base names, not paths.
+ignore=
+
+# Files or directories matching the regex patterns are skipped. The regex
+# matches against base names, not paths.
+ignore-patterns=
+
+# Pickle collected data for later comparisons.
+persistent=no
+
+# Use multiple processes to speed up Pylint.
+jobs=4
+
+
+[BASIC]
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=main,_
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=120
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=(?x)(
+  ^\s*(\#\ )?<?https?://\S+>?$|
+  ^\s*(from\s+\S+\s+)?import\s+.+$)

.vscode/python.code-workspace

@@ -0,0 +1,15 @@
+{
+	"extensions": {
+		"recommendations": [
+			"ms-python.autopep8",
+			"ms-python.vscode-pylance",
+			"ms-python.pylint",
+			"ms-python.python",
+			"ms-python.debugpy",
+			"jebbs.plantuml",
+			"njpwerner.autodocstring",
+			"DavidAnson.vscode-markdownlint",
+			"yzhang.markdown-all-in-one"
+		]
+	}
+}

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "editor.defaultFormatter": "ms-python.autopep8",
+    "editor.formatOnSave": true
+}

.vscode/template_NT.code-snippets

@@ -0,0 +1,31 @@
+{
+    "Python Template": {
+        "prefix": "template_file_python_nt",
+        "scope": "python",
+        "isFileTemplate": true,
+        "body": [
+            "\"\"\"${1:Enter short module description here}",
+            "",
+            "${2:Enter detailed module description here}",
+            "",
+            "Author: ${3:Name} (${4:mail})",
+            "\"\"\"",
+            "",
+            "#*******************************************************************************",
+            "# Copyright (c) NewTec GmbH $CURRENT_YEAR   -   www.newtec.de",
+            "#*******************************************************************************",
+            "",
+            "# Imports **********************************************************************",
+            "",
+            "# Variables ********************************************************************",
+            "",
+            "# Classes **********************************************************************",
+            "",
+            "# Functions ********************************************************************",
+            "",
+            "# Main *************************************************************************",
+            ""
+        ],
+        "description": "Python Template NewTec"
+    }
+}