build: scaffold development environment using tox

.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "build(deps): "
+    reviewers:
+      - "OLILHR"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "build(deps): "
+    reviewers:
+      - "OLILHR"

.github/workflows/byte_order_marks.yml

@@ -0,0 +1,15 @@
+name: "Prevent byte order marks."
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  bom-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: arma-actions/bom-check@v1
+        name: Check for BOM

.github/workflows/coverage.yml

@@ -0,0 +1,27 @@
+name: "Coverage."
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+jobs:
+  coverage:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - 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 tox
+      - name: Run tests and determine coverage
+        run: |
+          tox -e coverage

.github/workflows/dependabot_automerge.yml

@@ -0,0 +1,19 @@
+name: "Dependabot auto-approve/-merge."
+
+on: pull_request
+
+jobs:
+  dependabot:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    env:
+      PR_URL: ${{github.event.pull_request.html_url}}
+      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Approve pull request
+        run: gh pr review --approve "$PR_URL"
+      - name: Enable auto-merge
+        run: gh pr merge --auto --squash "$PR_URL"

.github/workflows/dev_environment.yml

@@ -0,0 +1,27 @@
+name: "Test dev environment."
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+jobs:
+  check:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - 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 tox
+      - name: Create dev environment
+        run: |
+          tox -e dev

.github/workflows/formatting.yml

@@ -0,0 +1,28 @@
+name: "Formatting."
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+jobs:
+  black:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+        tool: ["black", "isort"]
+    steps:
+      - 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 .[formatting]
+      - name: ${{ matrix.tool }} Code Formatter
+        run: |
+          ${{ matrix.tool }} . --check

.github/workflows/linting.yml

@@ -0,0 +1,29 @@
+name: "Linting."
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+jobs:
+  pylint:
+    name: Maintain code quality
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+        linter-env: ["linting", "typechecking", "spellchecking"]
+    steps:
+      - 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 tox
+      - name: Run ${{ matrix.linter-env }} via tox
+        run: |
+          tox -e ${{ matrix.linter-env }}

.github/workflows/packaging.yml

@@ -0,0 +1,38 @@
+name: "Packaging."
+
+on: [pull_request]
+
+jobs:
+  packaging:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - 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 tox
+
+      - name: Create temporary version tag
+        run: |
+          if [ -z "$(git tag)" ]; then
+            git config user.name "GitHub Actions"
+            git config user.email "actions@github.com"
+            git tag -a v0.0.0 -m "temporary tag"
+          fi
+
+      - name: Run packaging test
+        run: |
+          tox -e packaging

.github/workflows/publishing.yml

@@ -0,0 +1,57 @@
+name: "Publishing to PyPI."
+
+on:
+  release:
+    types: [created, edited]
+
+jobs:
+  testing:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install tox
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run tests
+        run: |
+          tox
+
+  deploying:
+    name: Build and deploy package to PyPI
+    runs-on: ubuntu-latest
+    # GitHub repository settings/environments/create "release" environment
+    # set up trusted publishing on https://pypi.org/ @ settings/manage/publishing
+    environment: release
+    permissions:
+        id-token: write
+    needs: testing
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[packaging]
+      - name: Build wheel and source distributions
+        run: |
+          pdm build
+      - name: Publish to PyPI
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/unittests.yml

@@ -0,0 +1,27 @@
+name: "Unittests."
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - 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 tox
+      - name: Run unittests via tox
+        run: |
+          tox -e testing

.gitignore

@@ -0,0 +1,17 @@
+.env*
+!*.example
+
+.coverage
+.idea/
+.pdm-build/
+.pytest_cache/
+.tox/
+.venv
+
+__pycache__/
+dist/
+htmlcov/
+
+# OS
+.DS_Store
+Thumbs.db