Initial commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,17 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+- **What is the faulty behavior?**
+
+- **Please provide the steps to reproduce and if possible a minimal demo of the problem**.
+
+- **What is the expected behavior?**
+
+- **Please tell us about your computing environment:**
+
+- **Other information**

.github/ISSUE_TEMPLATE/development_task.yaml

@@ -0,0 +1,32 @@
+name: "Development Task"
+description: "This is a template for a development task"
+# If you want to enable automatic linking to projects,
+# uncomment the following line and replace the project ID
+# with the ID of your project.
+# projects: ["cmi-dair/1"]
+title: "Task: "
+labels: ["task"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: "What is the task about? Why is it needed? What is the current state, if any?"
+      placeholder: "Describe the task here"
+    validations:
+      required: true
+  - type: textarea
+    id: tasks
+    attributes:
+      label: Tasks
+      description: "What are the concrete (sub-)tasks that need to be performed?"
+      placeholder: "Describe the tasks here."
+      value: "- [ ] Task 1"
+    validations:
+      required: true
+  - type: textarea
+    id: freeform-notes
+    attributes:
+      label: "Freeform Notes"
+      description: "Add any additional notes here."
+      placeholder: "Add notes here."

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest a change in the package's features.
+title: ''
+labels: ''
+assignees: ''
+---
+
+- **What is the current behavior?**
+
+- **What is the motivation / use case for changing the behavior?**
+
+- **If relevant, please tell us about your computing environment:**
+
+- **Other information**

.github/ISSUE_TEMPLATE/support_request.md

@@ -0,0 +1,15 @@
+---
+name: Support request
+about: Ask for help with this package.
+title: ''
+labels: ''
+assignees: ''
+---
+
+- **What are you trying to do?**
+
+- **What have you tried to do so far and what went wrong?**
+
+- **Please tell us about your computing environment:**
+
+- **Other information**

.github/dependabot.yml

@@ -0,0 +1,9 @@
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/docs.yml

@@ -0,0 +1,34 @@
+name: Build and publish docs
+
+permissions:
+  contents: write
+
+on:
+  workflow_run:
+    workflows: ["Python Tests"]
+    types:
+      - completed
+    branches:
+      - main
+
+jobs:
+  build-and-publish-docs:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install poetry
+          poetry install -E docs
+      - name: Build docs
+        run: |
+          APP_MODULE_NAME=$(ls src -U | head -1)  # Get the first module name in the src directory
+          poetry run pdoc src/"$APP_MODULE_NAME" -o docs_build -t docs/pdoc-theme --docformat google
+          touch docs_build/.nojekyll
+      - uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: docs_build

.github/workflows/test.yaml

@@ -0,0 +1,94 @@
+name: Python Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  unit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install poetry
+        run: pipx install poetry
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          cache: poetry
+      - name: Install dependencies
+        run: |
+          poetry install
+      - name: Run tests
+        id: run-tests
+        continue-on-error: true
+        run: >
+          poetry run pytest \
+            --junitxml=pytest.xml \
+            --cov-report=term-missing:skip-covered \
+            --cov-report=xml:coverage.xml \
+            --cov=src tests \
+            > ./pytest-coverage.txt;
+          cat ./pytest-coverage.txt;
+      - name: Upload pytest coverage artifacts.
+        uses: actions/upload-artifact@v3
+        with:
+          name: pytest-coverage
+          path: ./pytest-coverage.txt
+      - name: Upload pytest junitxml artifacts.
+        uses: actions/upload-artifact@v3
+        with:
+          name: pytest-junitxml
+          path: pytest.xml
+      - name: Checking testing success.
+        if: steps.run-tests.outcome != 'success'
+        run: exit 1;
+
+  coverage:
+    runs-on: ubuntu-latest
+    needs: unit
+    if: success() || failure()
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: Get pytest artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: pytest-coverage
+      - name: Get pytest junitxml artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: pytest-junitxml
+      - name: Pytest coverage comment
+        if: github.event_name == 'pull_request'
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: ./pytest-coverage.txt
+          junitxml-path: ./pytest.xml
+      - name: Upload coverage to Codecov
+        if: success() || failure()
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: chartboost/ruff-action@v1
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install poetry
+        run: pipx install poetry
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          cache: poetry
+      - run: |
+          poetry install
+          poetry run mypy .

.gitignore

@@ -0,0 +1,162 @@
+.ruff_cache
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+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/
+
+# 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/
+
+# 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/