chore(deps): update from template

helmut-hoffer-von-ankershoffen · helmut-hoffer-von-ankershoffen · commit 972493ea0d2b · 2025-04-24T14:07:31.000+02:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,4 +1,4 @@
-_commit: v0.13.13
+_commit: v0.14.4
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 attestations_enabled: true
 author_email: helmuthva@gmail.com
@@ -28,4 +28,3 @@ streamlit_project_key: oe-python-template-example
 uptime_badge_snippet: '[![Better Stack Badge](https://uptime.betterstack.com/status-badges/v1/monitor/1vzoq.svg)](https://helmut-hoffer-von-ankershoffen.betteruptime.com/)'
 vercel_badge_snippet: '[![Vercel Deploy](https://deploy-badge.vercel.app/vercel/oe-python-template-example?root=api%2Fv1%2Fhealthz)](https://oe-python-template-example.vercel.app/api/v1/hello/world)'
 vercel_function_enabled: true
-
diff --git a/.github/workflows/test-scheduled.yml b/.github/workflows/test-scheduled.yml
@@ -35,4 +35,17 @@ jobs:
           fail_on_empty: false
 
       - name: Run scheduled tests
-        run: make test_scheduled
+        env:
+          BETTERSTACK_HEARTBEAT_URL: "${{ secrets.BETTERSTACK_HEARTBEAT_TEST_SCHEDULED_URL }}"
+        run: |
+          make test_scheduled
+          EXIT_CODE=$?
+          # Provide heartbeat to betterstack for monitoring/alerting if heartbeat url is configured as secret
+          if [ -n "$BETTERSTACK_HEARTBEAT_ID" ]; then
+            if [ $EXIT_CODE -eq 0 ]; then
+              curl -s $BETTERSTACK_HEARTBEAT_URL
+            else
+              curl -s $BETTERSTACK_HEARTBEAT_URL/$EXIT_CODE
+            fi
+          fi
+          exit $EXIT_CODE
diff --git a/.gitignore b/.gitignore
@@ -2,11 +2,11 @@
 
 # Environment
 .env
-.env.backup
-.env.bak
+.env.*
+!.env.example
+.envrc
 ENV/
 env/
-.envrc
 
 ## secrets
 .secret
@@ -80,6 +80,10 @@ node_modules/
 # Copier
 *.rej
 
+# Scalene
+profile.json
+profile.html
+
 
 # Vercel
 .vercel
diff --git a/ATTRIBUTIONS.md b/ATTRIBUTIONS.md
@@ -12113,7 +12113,7 @@ License: LGPL-2.1-or-later
 
 ```
 
-## oe-python-template-example (0.4.8) - MIT License
+## oe-python-template-example (0.4.9) - MIT License
 
 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 
diff --git a/CLI_REFERENCE.md b/CLI_REFERENCE.md
@@ -14,7 +14,7 @@ $ oe-python-template-example [OPTIONS] COMMAND [ARGS]...
 * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
 * `--help`: Show this message and exit.
 
-🧠 OE Python Template Example v0.4.8 - built with love in Berlin 🐻
+🧠 OE Python Template Example v0.4.9 - built with love in Berlin 🐻
 
 **Commands**:
 
@@ -256,5 +256,5 @@ $ oe-python-template-example system sleep [OPTIONS]
 
 **Options**:
 
-* `--seconds INTEGER`: Duration in seconds  [default: 10]
+* `--seconds INTEGER`: Duration in seconds  [default: 2]
 * `--help`: Show this message and exit.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -130,7 +130,7 @@ Notes:
 To run the GUI in the browser with hot reloading, use the following command:
 
 ```shell
-make watch_gui
+make gui_watch
 ```
 
 ### Running GitHub CI Workflow locally
diff --git a/Dockerfile b/Dockerfile
@@ -105,6 +105,8 @@ HEALTHCHECK NONE
 # Default entrypoint is our CLI
 ENTRYPOINT ["oe-python-template-example"]
 
+# See https://matplotlib.org/stable/install/environment_variables_faq.html
+ENV MPLCONFIGDIR=/tmp/matplotlib
 
 # Target slim
 FROM target AS slim
diff --git a/Makefile b/Makefile
@@ -1,7 +1,7 @@
 # Makefile for running common development tasks
 
 # Define all PHONY targets
-.PHONY: all act audit bump clean dist dist_vercel docs docker_build install lint pre_commit_run_all setup setup test test_scheduled test_long_running update_from_template watch_gui
+.PHONY: all act audit bump clean dist dist_vercel docs docker_build install lint pre_commit_run_all profile setup setup test test_scheduled test_long_running update_from_template gui_watch
 
 # Main target i.e. default sessions defined in noxfile.py
 all:
@@ -63,8 +63,11 @@ docker_build:
 pre_commit_run_all:
 	uv run pre-commit run --all-files
 
-watch_gui:
-	uv run watch_gui.py
+gui_watch:
+	uv run runner/gui_watch.py
+
+profile:
+	uv run --all-extras python -m scalene runner/scalene.py
 
 # Special rule to catch any arguments (like patch, minor, major, pdf, Python versions, or x.y.z)
 # This prevents "No rule to make target" errors when passing arguments to make commands
@@ -85,14 +88,15 @@ help:
 	@echo "  dist_vercel           - Package as Vercel Function into dist_vercel/"
 	@echo "  docs [pdf]            - Build documentation (add pdf for PDF format)"
 	@echo "  docker_build          - Build Docker image oe-python-template-example"
+	@echo "  gui_watch             - Open GUI in browser and update on changes in source code"
 	@echo "  install               - Install or update development dependencies inc. pre-commit hooks"
 	@echo "  lint                  - Run linting and formatting checks"
 	@echo "  pre_commit_run_all    - Run pre-commit hooks on all files"
+	@echo "  profile               - Profile with Scalene"
 	@echo "  setup                 - Setup development environment"
 	@echo "  test [3.11|3.12|3.13] - Run tests (for specific Python version)"
 	@echo "  test_scheduled        - Run tests marked as scheduled with Python 3.11"
 	@echo "  test_long_running     - Run tests marked as long running with Python 3.11"
 	@echo "  update_from_template  - Update from template using copier"
-	@echo "  watch_gui             - Open GUI in browser and watch for changes"
 	@echo ""
 	@echo "Built with love in Berlin 🐻"
diff --git a/noxfile.py b/noxfile.py
@@ -691,10 +691,10 @@ def update_from_template(session: nox.Session) -> None:
         # In this case the template has been generated from a template
         session.run("copier", "update", "--trust", "--skip-answered", "--skip-tasks", external=True)
 
-    # Schedule the lint session to run after this session completes
-    session.notify("audit")
-    session.notify("docs")
-    session.notify("lint")
+        # Schedule the lint session to run after this session completes
+        session.notify("audit")
+        session.notify("docs")
+        session.notify("lint")
 
 
 @nox.session(default=False)
diff --git a/pyproject.toml b/pyproject.toml
@@ -120,6 +120,7 @@ dev = [
     "pytest-watcher>=0.4.3",
     "pytest-xdist[psutil]>=3.6.1",
     "ruff>=0.11.6",
+    "scalene>=1.5.51",
     "sphinx>=8.2.3",
     "sphinx-autobuild>=2024.10.3",
     "sphinx-copybutton>=0.5.2",
diff --git a/runner/__init__.py b/runner/__init__.py
@@ -0,0 +1 @@
+"""Runners for the project."""
diff --git a/runner/gui_watch.py b/runner/gui_watch.py
diff --git a/runner/scalene.py b/runner/scalene.py
@@ -0,0 +1,5 @@
+"""Wrapper for scalene."""
+
+from runpy import run_module
+
+run_module("oe_python_template_example.cli", run_name="cli")
diff --git a/src/oe_python_template_example/api.py b/src/oe_python_template_example/api.py
@@ -16,7 +16,7 @@
     __base__url__,
     __documentation__url__,
     __repository_url__,
-    locate_implementations,
+    load_modules,
 )
 
 TITLE = "OE Python Template Example"
@@ -67,12 +67,13 @@
         terms_of_service=TERMS_OF_SERVICE_URL,
     )
 
-# Register routers with appropriate API versions
-for router in locate_implementations(VersionedAPIRouter):
-    router_instance: VersionedAPIRouter = router
-    version = router_instance.version
+load_modules()
+
+# Register routers with appropriate API versions using the tracked instances
+for router in VersionedAPIRouter.get_instances():
+    version = router.version  # type: ignore
     if version in API_VERSIONS:
-        api_instances[version].include_router(router_instance)
+        api_instances[version].include_router(router)  # type: ignore
 
 # Mount all API versions to the main app
 for version in API_VERSIONS:
diff --git a/src/oe_python_template_example/hello/_api.py b/src/oe_python_template_example/hello/_api.py
@@ -8,7 +8,7 @@
 from collections.abc import Generator
 from typing import Annotated
 
-from fastapi import Depends
+from fastapi import APIRouter, Depends
 from pydantic import BaseModel, Field
 
 from oe_python_template_example.utils import VersionedAPIRouter
@@ -20,8 +20,8 @@
 
 # VersionedAPIRouters exported by modules via their __init__.py are automatically registered
 # and injected into the main API app, see ../api.py.
-api_v1 = VersionedAPIRouter("v1", prefix="/hello", tags=["hello"])
-api_v2 = VersionedAPIRouter("v2", prefix="/hello", tags=["hello"])
+api_v1: APIRouter = VersionedAPIRouter("v1", prefix="/hello", tags=["hello"])  # type: ignore
+api_v2: APIRouter = VersionedAPIRouter("v2", prefix="/hello", tags=["hello"])  # type: ignore
 
 
 def get_service() -> Generator[Service, None, None]:
diff --git a/src/oe_python_template_example/hello/_gui.py b/src/oe_python_template_example/hello/_gui.py
@@ -2,22 +2,24 @@
 
 from pathlib import Path
 
-from nicegui import ui
-
 from oe_python_template_example.utils import BasePageBuilder, GUILocalFilePicker
 
 from ._service import Service
 
 
 async def pick_file() -> None:
     """Open a file picker dialog and show notifier when closed again."""
-    result = await GUILocalFilePicker(str(Path.cwd() / "examples"), multiple=True)
+    from nicegui import ui  # noqa: PLC0415
+
+    result = await GUILocalFilePicker(str(Path.cwd() / "examples"), multiple=True)  # type: ignore
     ui.notify(f"You chose {result}")
 
 
 class PageBuilder(BasePageBuilder):
     @staticmethod
     def register_pages() -> None:
+        from nicegui import ui  # noqa: PLC0415
+
         @ui.page("/")
         def page_index() -> None:
             """Homepage of GUI."""
diff --git a/src/oe_python_template_example/system/_api.py b/src/oe_python_template_example/system/_api.py
@@ -110,7 +110,7 @@ def info_endpoint(
 
 api_routers = {}
 for version in API_VERSIONS:
-    router = VersionedAPIRouter(version, tags=["system"])
+    router: APIRouter = VersionedAPIRouter(version, tags=["system"])  # type: ignore
     api_routers[version] = router
     health = register_health_endpoint(api_routers[version])
     info = register_info_endpoint(api_routers[version])
diff --git a/src/oe_python_template_example/system/_cli.py b/src/oe_python_template_example/system/_cli.py
@@ -194,7 +194,7 @@ def fail() -> None:
 
 @cli.command()
 def sleep(
-    seconds: Annotated[int, typer.Option(help="Duration in seconds")] = 10,
+    seconds: Annotated[int, typer.Option(help="Duration in seconds")] = 2,
 ) -> None:
     """Sleep given for given number of seconds.
 
diff --git a/src/oe_python_template_example/system/_gui.py b/src/oe_python_template_example/system/_gui.py
@@ -1,14 +1,14 @@
 """Homepage (index) of GUI."""
 
-from nicegui import ui
-
 from ..utils import BasePageBuilder, __project_name__, __version__  # noqa: TID252
 from ._service import Service
 
 
 class PageBuilder(BasePageBuilder):
     @staticmethod
     def register_pages() -> None:
+        from nicegui import ui  # noqa: PLC0415
+
         @ui.page("/info")
         def page_info() -> None:
             """Homepage of GUI."""
diff --git a/src/oe_python_template_example/utils/__init__.py b/src/oe_python_template_example/utils/__init__.py
@@ -12,12 +12,13 @@
     __env_file__,
     __is_development_mode__,
     __is_running_in_container__,
+    __is_running_in_read_only_environment__,
     __project_name__,
     __project_path__,
     __repository_url__,
     __version__,
 )
-from ._di import locate_implementations, locate_subclasses
+from ._di import load_modules, locate_implementations, locate_subclasses
 from ._health import Health
 from ._log import LogSettings, get_logger
 from ._logfire import LogfireSettings
@@ -46,6 +47,7 @@
     "__env_file__",
     "__is_development_mode__",
     "__is_running_in_container__",
+    "__is_running_in_read_only_environment__",
     "__project_name__",
     "__project_path__",
     "__repository_url__",
@@ -54,6 +56,7 @@
     "console",
     "get_logger",
     "get_process_info",
+    "load_modules",
     "load_settings",
     "locate_implementations",
     "locate_subclasses",
diff --git a/src/oe_python_template_example/utils/_api.py b/src/oe_python_template_example/utils/_api.py
@@ -1,7 +1,9 @@
-from fastapi import APIRouter
+"""API router utilities for versioned FastAPI routers."""
 
+from typing import ClassVar
 
-class VersionedAPIRouter(APIRouter):
+
+class VersionedAPIRouter:
     """APIRouter with version attribute.
 
     - Use this class to create versioned routers for your FastAPI application
@@ -11,8 +13,53 @@ class VersionedAPIRouter(APIRouter):
     - See constants.por versions defined for this system.
     """
 
-    version: str
+    # Class variable to track all created instances
+    _instances: ClassVar[list["VersionedAPIRouter"]] = []
+
+    @classmethod
+    def get_instances(cls) -> list["VersionedAPIRouter"]:
+        """Get all created router instances.
+
+        Returns:
+            A list of all router instances created.
+        """
+        return cls._instances.copy()
+
+    def __new__(cls, version: str, *args, **kwargs) -> "VersionedAPIRouter":  # type: ignore[no-untyped-def]
+        """Create a new instance with lazy-loaded dependencies.
+
+        Args:
+            version: The API version this router belongs to.
+            *args: Arguments to pass to the FastAPI APIRouter.
+            **kwargs: Keyword arguments to pass to the FastAPI APIRouter.
+
+        Returns:
+            An instance of VersionedAPIRouter with lazy-loaded dependencies.
+        """
+        from fastapi import APIRouter  # Import only when creating an instance  # noqa: PLC0415
+
+        # Define the actual implementation class with the imports available
+        class VersionedAPIRouterImpl(APIRouter):
+            """Implementation of VersionedAPIRouter with lazy-loaded dependencies."""
+
+            version: str
+
+            def __init__(self, version: str, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]
+                """Initialize the router.
+
+                Args:
+                    version: The API version this router belongs to.
+                    *args: Arguments to pass to the FastAPI APIRouter.
+                    **kwargs: Keyword arguments to pass to the FastAPI APIRouter.
+                """
+                super().__init__(*args, **kwargs)
+                self.version = version
+
+        # Create an instance
+        instance = VersionedAPIRouterImpl(version, *args, **kwargs)
+
+        # Add to registry of instances
+        cls._instances.append(instance)  # type: ignore
 
-    def __init__(self, version: str, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]
-        super().__init__(*args, **kwargs)
-        self.version = version
+        # Return the instance but tell mypy it's a VersionedAPIRouter
+        return instance  # type: ignore[return-value]
diff --git a/src/oe_python_template_example/utils/_constants.py b/src/oe_python_template_example/utils/_constants.py
@@ -15,6 +15,14 @@
 __is_development_mode__ = "uvx" not in sys.argv[0].lower()
 __is_running_in_container__ = os.getenv(f"{__project_name__.upper()}_RUNNING_IN_CONTAINER")
 
+# Determine if we're running in a read-only runtime environment
+READ_ONLY_ENV_INDICATORS = [
+    f"{__project_name__.upper()}_RUNNING_IN_CONTAINER",
+    "VERCEL_ENV",
+    "RAILWAY_ENVIRONMENT",
+]
+__is_running_in_read_only_environment__ = any(os.getenv(env_var) is not None for env_var in READ_ONLY_ENV_INDICATORS)
+
 # Determine environment we are deployed on
 ENV_VAR_MAPPINGS = {
     "ENV": lambda env: env,
diff --git a/src/oe_python_template_example/utils/_di.py b/src/oe_python_template_example/utils/_di.py
diff --git a/src/oe_python_template_example/utils/_gui.py b/src/oe_python_template_example/utils/_gui.py
diff --git a/src/oe_python_template_example/utils/_log.py b/src/oe_python_template_example/utils/_log.py
diff --git a/src/oe_python_template_example/utils/_notebook.py b/src/oe_python_template_example/utils/_notebook.py
diff --git a/src/oe_python_template_example/utils/_sentry.py b/src/oe_python_template_example/utils/_sentry.py
diff --git a/tests/oe_python_template_example/system/cli_test.py b/tests/oe_python_template_example/system/cli_test.py
diff --git a/tests/oe_python_template_example/utils/log_test.py b/tests/oe_python_template_example/utils/log_test.py
diff --git a/tests/oe_python_template_example/utils/sentry_test.py b/tests/oe_python_template_example/utils/sentry_test.py
