Merge branch 'main' into documentation-updates

Signed-off-by: dcosteroarfima <[email protected]>

.github/dependabot.yml

@@ -0,0 +1,17 @@
+---
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # prettier-ignore
+  - package-ecosystem: "pip"  # See documentation for possible values
+    # prettier-ignore
+    directory: "/"  # Location of package manifests
+    commit-message:
+      prefix: "[dependabot] Chore:"
+    open-pull-requests-limit: 1
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yml

@@ -6,17 +6,20 @@ on:
   pull_request:
     branches: [ main ]
 
+env:
+  python-version: "3.8"
+
 jobs:
   ci:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+    - name: "Setup Python"
+      uses: actions/setup-python@v4.7.0
       with:
-        python-version: "3.8"
+        python-version: ${{ env.python-version }}
 
     - name: Install dependencies
       run: |

.github/workflows/release.yml

@@ -1,34 +1,63 @@
-# This workflow will upload a Python package using Twine when a tagged commit is merged.
+---
+name: "🐍📦 Production build and release"
 
-name: Publish on PyPI
+# GitHub/PyPI trusted publisher documentation:
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
 
+# yamllint disable-line rule:truthy
 on:
+  workflow_dispatch:
   push:
+    # Only invoked on release tag pushes
     tags:
-    - v*
+      - v*.*.*
 
-jobs:
-  deploy:
+env:
+  python-version: "3.8"
 
+jobs:
+  publish:
+    name: "🐍📦 Build and publish"
     runs-on: ubuntu-latest
-
+    environment:
+      name: pypi
+    permissions:
+      # IMPORTANT: mandatory for trusted publishing
+      id-token: write
     steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+      - name: "Checkout repository"
+        uses: actions/checkout@v4
+
+      - name: "Setup PDM for build commands"
+        uses: pdm-project/setup-pdm@v3
+        with:
+          version: 2.10.0
+
+      - name: "Setup Python"
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ env.python-version }}
+
+      - name: "Build with PDM backend"
+        run: |
+          pdm build
+
+      - name: "Sign packages with Sigstore"
+        uses: sigstore/[email protected]
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+
+      - name: "Remove files unsupported by PyPi"
+        run: |
+          if [ -f dist/buildvars.txt ]; then
+            rm dist/buildvars.txt
+          fi
+          rm dist/*.sigstore | true
+
+      - name: "Publish package to PyPI"
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test-release.yml

@@ -0,0 +1,69 @@
+---
+name: "🐍📦 Test build and publish to Test PyPI"
+
+# GitHub/PyPI trusted publisher documentation:
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+# yamllint disable-line rule:truthy
+on: push
+
+env:
+  python-version: "3.8"
+
+jobs:
+  publish:
+    name: "🐍📦 Test build and publish"
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+    permissions:
+      # IMPORTANT: mandatory for trusted publishing
+      id-token: write
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v4
+
+      - name: "Setup PDM for build commands"
+        uses: pdm-project/setup-pdm@v3
+        with:
+          version: 2.10.0
+
+      - name: "Setup Python"
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ env.python-version }}
+
+      - name: "Update version and output Run ID"
+        run: |
+          value=`scripts/version.sh`
+          scripts/dev-versioning.sh "$value-dev${{ github.run_id }}"
+          echo "$value-dev${{ github.run_id }}"
+          echo ${{ github.run_id }}
+
+      - name: "Output Run Number"
+        run: echo ${{ github.run_number }}
+
+      - name: "Build with PDM backend"
+        run: |
+          pdm build
+
+      - name: "Sign packages with Sigstore"
+        uses: sigstore/[email protected]
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+
+      - name: "Remove files unsupported by PyPi"
+        run: |
+          if [ -f dist/buildvars.txt ]; then
+            rm dist/buildvars.txt
+          fi
+          rm dist/*.sigstore | true
+
+      - name: Publish distribution to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}

.gitignore

@@ -95,3 +95,4 @@ target/
 .venv/*
 src/test/data/coords.json
 credentials.env
+.pdm-python

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
       - id: check-merge-conflict
@@ -19,24 +19,24 @@ repos:
       - id: debug-statements
 
   - repo: https://github.com/Lucas-C/pre-commit-hooks
-    rev: v1.1.13
+    rev: v1.5.4
     hooks:
       - id: remove-tabs
 
   - repo: https://github.com/psf/black
-    rev: '22.3.0'
+    rev: '24.1.1'
     hooks:
       - id: black
       - id: black-jupyter
 
   - repo: https://github.com/s-weigand/flake8-nb
-    rev: v0.4.0
+    rev: v0.5.3
     hooks:
       - id: flake8-nb
         additional_dependencies:
           - pep8-naming
         # Ignore all format-related checks as Black takes care of those.
         args:
-          - --ignore=E2, W5, F401, E401
+          - --ignore=E2, W5, F401, E401, E704
           - --select=E, W, F, N
           - --max-line-length=120