Automatic formatting via black + CI support

.github/workflows/formatapply.yml

@@ -0,0 +1,38 @@
+name: apply-code-format
+
+on: [ workflow_dispatch ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: psf/black@stable
+        with:
+          options: ""
+          src: "."
+          jupyter: true
+      - name: Commit Formatting
+        run: |
+          git config user.name 'Auto Format'
+          git config user.email '[email protected]'
+          if [ -z "$(git status --porcelain)" ]
+          then
+          echo "Code did not change"
+          else
+          git commit -am "Applied code formatting"
+          git rev-parse HEAD >> .git-blame-ignore-revs
+          git commit -am "Add code formatting commit to .git-blame-ignore-revs"
+          fi
+      - name: Create Pull Request
+        id: cpr
+        uses: peter-evans/create-pull-request@v6
+        with:
+          branch: ci/apply-code-format
+          delete-branch: true
+          title: 'Code formatting'
+          body: |
+            Auto-generated pull request triggered by the `apply-code-format` workflow.
+            - Manually close and reopen this PR to trigger the CI.
+            - Make sure to **merge** (and not rebase) this PR so that the added commit hash in `.git-blame-ignore-revs` remains valid.

.github/workflows/formatcheck.yml

@@ -0,0 +1,15 @@
+name: check-code-format
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: psf/black@stable
+      with:
+        options: "--check --diff --color"
+        src: "."
+        jupyter: true

setup.py

@@ -235,6 +235,7 @@ def finalize_options(self):
         "plot":  ["matplotlib","numpy","scipy"],
         "test": ["pytest", "nbval", "numpy"],
         "doc": ["Sphinx", "sphinx-bootstrap-theme", "nbsphinx", "ipython", "ipykernel"], # also requires pandoc to be installed
+        "dev": ["black"],
     },
     python_requires='>=3.7', # required by packaging
 )