Add code checks

Include dependencies needed for linting and type checking and add
a GitHub workflow to run the checks.

.github/workflows/run-code-checks.yaml

@@ -0,0 +1,38 @@
+name: run-code-checks
+
+on:
+  push:
+  pull_request:
+    # to avoid duplicate workflow runs, don't run when PR is synchronized
+    # (which is the default) because it will run on the push
+    types: [opened, reopened, ready_for_review]
+  workflow_dispatch:
+
+jobs:
+  run-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+
+      - name: Set up PDM 🗻
+        # using the PDM action because actions/setup-python doesn't suppport
+        # caching for PDM out of the box
+        # https://github.com/pdm-project/setup-pdm?tab=readme-ov-file#why-do-i-need-this-action
+        uses: pdm-project/setup-pdm@v4
+        with:
+          cache: true
+
+      - name: Install dependencies 📦
+        run: pdm install
+
+      - name: lint 🧹
+        run: pdm run ruff check
+
+      - name: type check ✔️
+        run: pdm run mypy . --ignore-missing-imports
+
+      - name: run tests 🧪
+        run: pdm run pytest
+
+

pyproject.toml

@@ -21,8 +21,10 @@ authors = [
 [project.optional-dependencies]
 dev = [
     'coverage',
+    'mypy',
     'pytest',
     'pytest-mock',
+    'ruff',
 ]
 
 [build-system]