Merge pull request #19 from Appsilon/pps-add-mypy

feat: add mypy for type checking

.github/workflows/main.yaml

@@ -12,7 +12,7 @@ jobs:
       - name: Checkout (GitHub)
         uses: actions/checkout@v4
 
-      - name: Build and run dev container tests
+      - name: Run quality checks
         uses: devcontainers/ci@v0.3
         with:
-          runCmd: ./run_tests_and_bandit.sh
+          runCmd: ./quality_checks.sh

README.md

@@ -83,6 +83,7 @@ Our template ensures a streamlined development lifecycle, offering:
 - **Structured Logging with Loguru**: Enhanced debugging and monitoring.
 - **Best Practice Configuration**: Using `pydantic-settings`.
 - **Efficient Deployment**: Smooth deployment to Posit Connect with `rsconnect`.
+- **Static Type Checking with mypy**: Ensures type safety and code quality.
 
 ## Community and Contributions
 

pyproject.toml

@@ -32,6 +32,7 @@ tenacity = "^8.2.3"
 bandit = "^1.7.8"
 pytest-watch = "^4.2.0"
 pytest-cov = "^5.0.0"
+mypy = "^1.9.0"
 
 [build-system]
 requires = ["poetry-core"]

quality_checks.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+# This script is for running quality checks in GitHub Actions.
+# It runs tests, security analysis with Bandit, and type checks with mypy.
+
+set -e # Exit immediately if a command exits with a non-zero status.
+
+echo "Running pytest for unit tests..."
+poetry run pytest
+
+echo "Running Bandit for security analysis..."
+poetry run bandit -r pyshiny_template
+
+echo "Running mypy for type checking..."
+poetry run mypy pyshiny_template