Migrate CI pipeline to use hatch

.github/actions/initialize-hatch/action.yml

@@ -0,0 +1,16 @@
+name: "Initialize Hatch"
+description: "Install hatch & create an environment"
+inputs:
+  environment-name:
+    description: "Which environment to create"
+    default: "default"
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - name: "Install hatch"
+      run: pip install -r requirements-bootstrap.txt
+      shell: "bash"
+    - name: "Create environment"
+      run: "hatch --verbose env create ${{ inputs.environment-name }}"
+      shell: "bash"

.github/actions/publish-docs-with-mike/action.sh

@@ -2,6 +2,8 @@
 
 set -eo pipefail
 
+hatch -e docs shell
+
 echo "::group::Configure Git User"
 "${GITHUB_ACTION_PATH}/configure_git_user.sh"
 echo "::endgroup::"

.github/workflows/main.yml

@@ -18,13 +18,11 @@ jobs:
       - uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-      - name: Install dependencies
-        uses: ./.github/actions/install-dependencies
-        with:
-          test-requirements: "true"
+      - name: Initialize Hatch
+        uses: ./.github/actions/initialize-hatch
 
       - name: Run bandit
-        run: bandit --ini .bandit -r .
+        run: hatch run bandit-ci
 
   black:
     runs-on: ubuntu-latest
@@ -35,13 +33,11 @@ jobs:
         uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-      - name: Install dependencies
-        uses: ./.github/actions/install-dependencies
-        with:
-          test-requirements: "true"
+      - name: Initialize Hatch
+        uses: ./.github/actions/initialize-hatch
 
       - name: Run black
-        run: black --check .
+        run: hatch run black-check
 
   flake8:
     runs-on: ubuntu-latest
@@ -51,13 +47,11 @@ jobs:
         - uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
           with:
             python-version: ${{ env.PYTHON_VERSION }}
-        - name: Install dependencies
-          uses: ./.github/actions/install-dependencies
-          with:
-            test-requirements: "true"
+        - name: Initialize Hatch
+          uses: ./.github/actions/initialize-hatch
 
         - name: Run flake8
-          run: flake8
+          run: hatch run flake8-check
 
   isort:
     runs-on: ubuntu-latest
@@ -67,14 +61,11 @@ jobs:
       - uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-      - name: Install dependencies
-        uses: ./.github/actions/install-dependencies
-        with:
-          requirements: "true"
-          test-requirements: "true"
+      - name: Initialize Hatch
+        uses: ./.github/actions/initialize-hatch
 
       - name: Run isort
-        run: isort --check-only .
+        run: hatch run isort-check
 
   mypy:
     runs-on: ubuntu-latest
@@ -84,15 +75,11 @@ jobs:
         - uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
           with:
             python-version: ${{ env.PYTHON_VERSION }}
-        - name: Install dependencies
-          uses: ./.github/actions/install-dependencies
-          with:
-            requirements: "true"
-            test-requirements: "true"
+        - name: Initialize Hatch
+          uses: ./.github/actions/initialize-hatch
 
         - name: Run mypy
-          run: mypy
-
+          run: hatch run typing
 
   renovate:
     runs-on: ubuntu-latest
@@ -114,14 +101,11 @@ jobs:
         - uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
           with:
             python-version: ${{ matrix.python-version }}
-        - name: Install dependencies
-          uses: ./.github/actions/install-dependencies
-          with:
-            requirements: "true"
-            test-requirements: "true"
+        - name: Initialize Hatch
+          uses: ./.github/actions/initialize-hatch
 
         - name: Run pytest
-          run: pytest --cov-report xml:coverage-${{ matrix.python-version }}.xml --junitxml=test-results-${{ matrix.python-version }}.xml
+          run: hatch run test-ci --cov-report xml:coverage-${{ matrix.python-version }}.xml --junitxml=test-results-${{ matrix.python-version }}.xml
 
         - name: Upload pytest test results artifact
           uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3
@@ -177,9 +161,11 @@ jobs:
     steps:
       - name: Check out code
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-
+      - name: Initialize Hatch
+        uses: ./.github/actions/initialize-hatch
+
       - name: Validate docs
-        run: ./docker/validate_docs.sh
+        run: hatch run test-docs-examples
 
   build-docs:
     runs-on: ubuntu-latest
@@ -191,15 +177,13 @@ jobs:
       - uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-
-      - name: Install dependencies
-        uses: ./.github/actions/install-dependencies
+      - name: Initialize Hatch
+        uses: ./.github/actions/initialize-hatch
         with:
-          requirements: "true"
-          docs-requirements: "true"
+          environment-name: "docs"
 
       - name: Build Docs
-        run: mkdocs build --strict
+        run: hatch run docs:build
 
       - name: Upload coverage results artifact
         uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3
@@ -217,12 +201,10 @@ jobs:
       - uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-
-      - name: Install dependencies
-        uses: ./.github/actions/install-dependencies
+      - name: Initialize Hatch
+        uses: ./.github/actions/initialize-hatch
         with:
-          requirements: "true"
-          docs-requirements: "true"
+          environment-name: "docs"
 
       - name: Push documentation changes
         uses: ./.github/actions/publish-docs-with-mike

docker/validate_docs.sh

@@ -4,9 +4,6 @@
 # this is set so that the script fails if one example fails to be executed properly
 set -e
 
-# install columbo
-pip install . -q
-
 for filename in docs/examples/*.py; do
     printf "\n\n --- %s ---\n" "${filename}"
     # provide default answers if example python file asks for input

pyproject.toml

@@ -65,7 +65,8 @@ _fmt = [
 black-check = "black --check --diff ."
 isort-check = "isort --check-only ."
 flake8-check = "flake8"
-bandit-check = "bandit --ini .bandit --quiet -r ."
+bandit-ci = "bandit --ini .bandit -r ."
+bandit-check = "bandit-ci --quiet"
 check-strict = [
     "black-check",
     "isort-check",