first commit

.coveragerc

@@ -0,0 +1,20 @@
+
+[run]
+source = src
+
+[report]
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:

.github/labels.yml

@@ -0,0 +1,66 @@
+---
+# Labels names are important as they are used by Release Drafter to decide
+# regarding where to record them in changelog or if to skip them.
+#
+# The repository labels will be automatically configured using this file and
+# the GitHub Action https://github.com/marketplace/actions/github-labeler.
+- name: breaking
+  description: Breaking Changes
+  color: bfd4f2
+- name: bug
+  description: Something isn't working
+  color: d73a4a
+- name: build
+  description: Build System and Dependencies
+  color: bfdadc
+- name: ci
+  description: Continuous Integration
+  color: 4a97d6
+- name: dependencies
+  description: Pull requests that update a dependency file
+  color: 0366d6
+- name: documentation
+  description: Improvements or additions to documentation
+  color: 0075ca
+- name: duplicate
+  description: This issue or pull request already exists
+  color: cfd3d7
+- name: enhancement
+  description: New feature or request
+  color: a2eeef
+- name: github_actions
+  description: Pull requests that update Github_actions code
+  color: "000000"
+- name: good first issue
+  description: Good for newcomers
+  color: 7057ff
+- name: help wanted
+  description: Extra attention is needed
+  color: 008672
+- name: invalid
+  description: This doesn't seem right
+  color: e4e669
+- name: performance
+  description: Performance
+  color: "016175"
+- name: python
+  description: Pull requests that update Python code
+  color: 2b67c6
+- name: question
+  description: Further information is requested
+  color: d876e3
+- name: refactoring
+  description: Refactoring
+  color: ef67c4
+- name: removal
+  description: Removals and Deprecations
+  color: 9ae7ea
+- name: style
+  description: Style
+  color: c120e5
+- name: testing
+  description: Testing
+  color: b1fc6f
+- name: wontfix
+  description: This will not be worked on
+  color: ffffff

.github/release-drafter.yml

@@ -0,0 +1,28 @@
+categories:
+    - title: ":boom: Breaking Changes"
+      label: "breaking"
+    - title: ":rocket: Features"
+      label: "enhancement"
+    - title: ":fire: Removals and Deprecations"
+      label: "removal"
+    - title: ":beetle: Fixes"
+      label: "bug"
+    - title: ":racehorse: Performance"
+      label: "performance"
+    - title: ":rotating_light: Testing"
+      label: "testing"
+    - title: ":construction_worker: Continuous Integration"
+      label: "ci"
+    - title: ":books: Documentation"
+      label: "documentation"
+    - title: ":hammer: Refactoring"
+      label: "refactoring"
+    - title: ":lipstick: Style"
+      label: "style"
+    - title: ":package: Dependencies"
+      labels:
+          - "dependencies"
+          - "build"
+template: |
+    ## Changes
+    $CHANGES

.github/workflows/code-quality-main.yaml

@@ -0,0 +1,54 @@
+# Same as `code-quality-pr.yaml` but triggered on commit to main branch
+# and runs on all files (instead of only the changed ones)
+
+name: Code Quality Main
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  code-quality:
+    runs-on: ubuntu-latest
+
+    steps:
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Set up Python 3.9
+        id: setup-python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      #----------------------------------------------
+      #  -----  install & configure poetry  -----
+      #----------------------------------------------
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+
+      #----------------------------------------------
+      #       load cached venv if cache exists
+      #----------------------------------------------
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+      #----------------------------------------------
+      # install dependencies if cache does not exist
+      #----------------------------------------------
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+
+      - name: Run pre-commits
+        uses: pre-commit/[email protected]

.github/workflows/code-quality-pr.yaml

@@ -0,0 +1,73 @@
+# This workflow finds which files were changed, prints them,
+# and runs `pre-commit` on those files.
+
+# Inspired by the sktime library:
+# https://github.com/alan-turing-institute/sktime/blob/main/.github/workflows/test.yml
+
+name: Code Quality PR
+
+on:
+  pull_request:
+    branches: [main, "release/*"]
+
+jobs:
+  code-quality:
+    runs-on: ubuntu-latest
+
+    steps:
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Set up Python 3.9
+        id: setup-python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      #----------------------------------------------
+      #  -----  install & configure poetry  -----
+      #----------------------------------------------
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+
+      #----------------------------------------------
+      #       load cached venv if cache exists
+      #----------------------------------------------
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+      #----------------------------------------------
+      # install dependencies if cache does not exist
+      #----------------------------------------------
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+
+      #----------------------------------------------
+      # find and list modified files
+      #----------------------------------------------
+      - name: Find modified files
+        id: file_changes
+        uses: trilom/[email protected]
+        with:
+          output: " "
+      - name: List modified files
+        run: echo '${{ steps.file_changes.outputs.files}}'
+
+      #----------------------------------------------
+      # run pre-commit on modified files
+      #----------------------------------------------
+      - name: Run pre-commits
+        uses: pre-commit/[email protected]
+        with:
+          extra_args: --files ${{ steps.file_changes.outputs.files}}

.github/workflows/constraints.txt

@@ -0,0 +1,2 @@
+pip==23.2.1
+poetry==1.6.1

.github/workflows/labeler.yml

@@ -0,0 +1,19 @@
+name: Labeler
+
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    labeler:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out the repository
+              uses: actions/checkout@v3
+
+            - name: Run Labeler
+              uses: crazy-max/ghaction-github-labeler@v5
+              with:
+                  github-token: ${{ secrets.GITHUB_TOKEN }}
+                  skip-delete: true

.github/workflows/release.yml

@@ -0,0 +1,83 @@
+name: Release
+
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    release:
+        name: Release
+        runs-on: ubuntu-latest
+        steps:
+          - name: Check out the repository
+            uses: actions/[email protected]
+            with:
+                fetch-depth: 2
+
+          - name: Set up Python
+            uses: actions/[email protected]
+            with:
+                python-version: "3.9"
+
+          - name: Upgrade pip
+            run: |
+                pip install --constraint=.github/workflows/constraints.txt pip
+                pip --version
+          - name: Install Poetry
+            run: |
+                pip install --constraint=.github/workflows/constraints.txt poetry
+                poetry --version
+
+          #----------------------------------------------
+          #  -----  build the package  -----
+          #----------------------------------------------
+          - name: Check if there is a parent commit
+            id: check-parent-commit
+            run: |
+                echo "::set-output name=sha::$(git rev-parse --verify --quiet HEAD^)"
+          - name: Detect and tag new version
+            id: check-version
+            if: steps.check-parent-commit.outputs.sha
+            uses: salsify/[email protected]
+            with:
+                version-command: |
+                    bash -o pipefail -c "poetry version | awk '{ print \$2 }'"
+          - name: Bump version for developmental release
+            if: "! steps.check-version.outputs.tag"
+            run: |
+                poetry version patch &&
+                version=$(poetry version | awk '{ print $2 }') &&
+                poetry version $version.dev.$(date +%s)
+          - name: Build package
+            run: |
+                poetry build --ansi
+
+          #----------------------------------------------
+          #  -----  publish the package  -----
+          #----------------------------------------------
+          - name: Publish package on PyPI
+            if: steps.check-version.outputs.tag
+            uses: pypa/[email protected]
+            with:
+                user: __token__
+                password: ${{ secrets.PYPI_TOKEN }}
+
+          - name: Publish package on TestPyPI
+            if: "! steps.check-version.outputs.tag"
+            uses: pypa/[email protected]
+            with:
+                user: __token__
+                password: ${{ secrets.TEST_PYPI_TOKEN }}
+                repository_url: https://test.pypi.org/legacy/
+
+          #----------------------------------------------
+          #  -----  create github release notes -----
+          #----------------------------------------------
+          - name: Publish the release notes
+            uses: release-drafter/[email protected]
+            with:
+                publish: ${{ steps.check-version.outputs.tag != '' }}
+                tag: ${{ steps.check-version.outputs.tag }}
+            env:
+                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}