chore(deps): update from template

helmut-hoffer-von-ankershoffen · helmut-hoffer-von-ankershoffen · commit 5a813bef2d0b · 2025-04-13T23:06:56.000+02:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,4 +1,4 @@
-_commit: v0.10.5
+_commit: v0.10.7
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 attestations_enabled: true
 author_email: helmuthva@gmail.com
diff --git a/.github/workflows/test-and-report.yml b/.github/workflows/test-and-report.yml
@@ -59,7 +59,7 @@ jobs:
           envkey_OE_PYTHON_TEMPLATE_EXAMPLE_SENTRY_DSN: "${{ secrets.OE_PYTHON_TEMPLATE_EXAMPLE_SENTRY_DSN }}"
           envkey_OE_PYTHON_TEMPLATE_EXAMPLE_LOGGING_LOG_LEVEL: "DEBUG"
           envkey_OE_PYTHON_TEMPLATE_EXAMPLE_LOGGING_LOG_FILE_ENABLED: 1
-          fail_on_empty: true
+          fail_on_empty: false
 
       - name: Validate installation
         run: |
diff --git a/.github/workflows/test-scheduled.yml b/.github/workflows/test-scheduled.yml
@@ -34,7 +34,7 @@ jobs:
           envkey_OE_PYTHON_TEMPLATE_EXAMPLE_SENTRY_DSN: "${{ secrets.OE_PYTHON_TEMPLATE_EXAMPLE_SENTRY_DSN }}"
           envkey_OE_PYTHON_TEMPLATE_EXAMPLE_LOGGING_LOG_LEVEL: "DEBUG"
           envkey_OE_PYTHON_TEMPLATE_EXAMPLE_LOGGING_LOG_FILE_ENABLED: 1
-          fail_on_empty: true
+          fail_on_empty: false
 
       - name: Run scheduled tests
         run: make test_scheduled
diff --git a/ATTRIBUTIONS.md b/ATTRIBUTIONS.md
@@ -10521,7 +10521,7 @@ License: LGPL-2.1-or-later
 
 ```
 
-## oe-python-template-example (0.3.6) - MIT License
+## oe-python-template-example (0.3.7) - MIT License
 
 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 
@@ -27699,6 +27699,41 @@ https://opensource.apple.com/source/tcl/tcl-14/tcl/license.terms
 
 ```
 
+## uptime (3.0.1) - BSD License
+
+Cross-platform uptime library
+
+* URL: https://github.com/Cairnarvon/uptime
+* Author(s): Koen Crolla
+
+### License Text
+
+```
+Copyright (c) 2012, Koen Crolla
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+```
+
 ## uri-template (1.3.0) - MIT License
 
 RFC 6570 URI Template Processor
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.3.6 - built with love in Berlin 🐻
+🧠 OE Python Template Example v0.3.7 - built with love in Berlin 🐻
 
 **Commands**:
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -145,7 +145,7 @@ Build and run the Docker image with plain Docker
 
 ```shell
 # Build from Dockerimage
-make docker build
+make docker_build
 # Run the CLI
 docker run --env THE_VAR=THE_VALUE oe-python-template-example --help
 ```
diff --git a/README.md b/README.md
@@ -90,7 +90,7 @@ Projects generated with this template come with a comprehensive development tool
 
 Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and enterprise practices already in place:
 
-1. Usable as library with "Hello" module exposing a simple service
+1. Usable as library with "Hello" module exposing a simple service that can say "Hello, world!" and echo utterances.
 2. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
 3. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
 4. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
@@ -100,8 +100,9 @@ Beyond development tooling, projects generated with this template include the co
 8. Info command enabling to inspect the runtime, compiled settings, and further info provided dynamically by modules
 9. Health endpoint exposing system health dynamically aggregated from all modules and dependencies
 10. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) 
-11. Modular architecture including auto-registration of services, CLI commands and API routes exposed by modules
-12. Documentation including dynamic badges, setup instructions, contribution guide and security policy
+11. Hello service demonstrates use of custom real time metrics collected via Logfire
+12. Modular architecture including auto-registration of services, CLI commands and API routes exposed by modules
+13. Documentation including dynamic badges, setup instructions, contribution guide and security policy
 
 Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
 
diff --git a/compose.yaml b/compose.yaml
@@ -3,7 +3,7 @@ services:
     build: .
     env_file:
       - path: .env
-        required: true
+        required: false
     develop:
       watch:
         - path: src
@@ -17,7 +17,7 @@ services:
     build: .
     env_file:
       - path: .env
-        required: true
+        required: false
     develop:
       watch:
         - path: src
diff --git a/docs/partials/README_main.md b/docs/partials/README_main.md
@@ -43,7 +43,7 @@ Projects generated with this template come with a comprehensive development tool
 
 Beyond development tooling, projects generated with this template include the code, documentation, and configuration of a fully functioning application and service. This reference implementation serves as a starting point for your own business logic with modern patterns and enterprise practices already in place:
 
-1. Usable as library with "Hello" module exposing a simple service
+1. Usable as library with "Hello" module exposing a simple service that can say "Hello, world!" and echo utterances.
 2. Command-line interface (CLI) with [Typer](https://typer.tiangolo.com/)
 3. Versioned webservice API with [FastAPI](https://fastapi.tiangolo.com/)
 4. [Interactive Jupyter notebook](https://jupyter.org/) and [reactive Marimo notebook](https://marimo.io/)
@@ -53,8 +53,9 @@ Beyond development tooling, projects generated with this template include the co
 8. Info command enabling to inspect the runtime, compiled settings, and further info provided dynamically by modules
 9. Health endpoint exposing system health dynamically aggregated from all modules and dependencies
 10. Flexible logging and instrumentation, including support for [Sentry](https://sentry.io/) and [Logfire](https://logfire.dev/) 
-11. Modular architecture including auto-registration of services, CLI commands and API routes exposed by modules
-12. Documentation including dynamic badges, setup instructions, contribution guide and security policy
+11. Hello service demonstrates use of custom real time metrics collected via Logfire
+12. Modular architecture including auto-registration of services, CLI commands and API routes exposed by modules
+13. Documentation including dynamic badges, setup instructions, contribution guide and security policy
 
 Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
 
diff --git a/src/oe_python_template_example/hello/_service.py b/src/oe_python_template_example/hello/_service.py
@@ -5,6 +5,7 @@
 from http import HTTPStatus
 from typing import Any
 
+import logfire
 import requests
 
 from oe_python_template_example.utils import BaseService, Health
@@ -74,6 +75,9 @@ def get_hello_world(self) -> str:
         Returns:
             str: Hello world message.
         """
+        messages_sent = logfire.metric_counter("hello_world_messages_sent")
+        messages_sent.add(1)
+
         match self._settings.language:
             case Language.GERMAN:
                 return HELLO_WORLD_DE_DE
diff --git a/src/oe_python_template_example/hello/_settings.py b/src/oe_python_template_example/hello/_settings.py
@@ -3,10 +3,15 @@
 from enum import StrEnum
 from typing import Annotated
 
-from pydantic import Field
-from pydantic_settings import BaseSettings, SettingsConfigDict
+from pydantic import BeforeValidator, Field, PlainSerializer, SecretStr
+from pydantic_settings import SettingsConfigDict
 
-from oe_python_template_example.utils import __env_file__, __project_name__
+from oe_python_template_example.utils import (
+    OpaqueSettings,
+    __env_file__,
+    __project_name__,
+    strip_to_none_before_validator,
+)
 
 
 class Language(StrEnum):
@@ -18,7 +23,7 @@ class Language(StrEnum):
 
 # Settings derived from BaseSettings and exported by modules via their __init__.py are automatically registered
 # by the system module e.g. for showing all settings via the system info command.
-class Settings(BaseSettings):
+class Settings(OpaqueSettings):
     """Settings."""
 
     model_config = SettingsConfigDict(
@@ -35,3 +40,15 @@ class Settings(BaseSettings):
             description="Language to use for output - defaults to US english.",
         ),
     ]
+
+    token: Annotated[
+        SecretStr | None,
+        BeforeValidator(strip_to_none_before_validator),  # strip and if empty set to None
+        PlainSerializer(
+            func=OpaqueSettings.serialize_sensitive_info, return_type=str, when_used="always"
+        ),  # allow to unhide sensitive info from CLI or if user presents valid token via API
+        Field(
+            description="Secret token of Hello module.",
+            default=None,
+        ),
+    ]
diff --git a/src/oe_python_template_example/utils/__init__.py b/src/oe_python_template_example/utils/__init__.py
@@ -23,7 +23,7 @@
 from ._process import ProcessInfo, get_process_info
 from ._sentry import SentrySettings
 from ._service import BaseService
-from ._settings import UNHIDE_SENSITIVE_INFO, OpaqueSettings, load_settings
+from ._settings import UNHIDE_SENSITIVE_INFO, OpaqueSettings, load_settings, strip_to_none_before_validator
 from .boot import boot
 
 __all__ = [
@@ -56,4 +56,5 @@
     "locate_implementations",
     "locate_subclasses",
     "prepare_cli",
+    "strip_to_none_before_validator",
 ]
diff --git a/src/oe_python_template_example/utils/_logfire.py b/src/oe_python_template_example/utils/_logfire.py
@@ -3,11 +3,11 @@
 from typing import Annotated
 
 import logfire
-from pydantic import Field, PlainSerializer, SecretStr
+from pydantic import BeforeValidator, Field, PlainSerializer, SecretStr
 from pydantic_settings import SettingsConfigDict
 
 from ._constants import __env__, __env_file__, __project_name__, __repository_url__, __version__
-from ._settings import OpaqueSettings, load_settings
+from ._settings import OpaqueSettings, load_settings, strip_to_none_before_validator
 
 
 class LogfireSettings(OpaqueSettings):
@@ -22,6 +22,7 @@ class LogfireSettings(OpaqueSettings):
 
     token: Annotated[
         SecretStr | None,
+        BeforeValidator(strip_to_none_before_validator),
         PlainSerializer(func=OpaqueSettings.serialize_sensitive_info, return_type=str, when_used="always"),
         Field(description="Logfire token. Leave empty to disable logfire.", examples=["YOUR_TOKEN"], default=None),
     ]
diff --git a/src/oe_python_template_example/utils/_sentry.py b/src/oe_python_template_example/utils/_sentry.py
@@ -3,12 +3,12 @@
 from typing import Annotated
 
 import sentry_sdk
-from pydantic import Field, PlainSerializer, SecretStr
+from pydantic import BeforeValidator, Field, PlainSerializer, SecretStr
 from pydantic_settings import SettingsConfigDict
 from sentry_sdk.integrations.typer import TyperIntegration
 
 from ._constants import __env__, __env_file__, __project_name__, __version__
-from ._settings import OpaqueSettings, load_settings
+from ._settings import OpaqueSettings, load_settings, strip_to_none_before_validator
 
 
 class SentrySettings(OpaqueSettings):
@@ -23,6 +23,7 @@ class SentrySettings(OpaqueSettings):
 
     dsn: Annotated[
         SecretStr | None,
+        BeforeValidator(strip_to_none_before_validator),
         PlainSerializer(func=OpaqueSettings.serialize_sensitive_info, return_type=str, when_used="always"),
         Field(description="Sentry DSN", examples=["https://SECRET@SECRET.ingest.de.sentry.io/SECRET"], default=None),
     ]
@@ -44,26 +45,30 @@ class SentrySettings(OpaqueSettings):
         int,
         Field(
             description="Max breadcrumbs (https://docs.sentry.io/platforms/python/configuration/options/#max_breadcrumbs)",
-            default=5.0,
+            ge=0,
+            default=50,
         ),
     ]
     sample_rate: Annotated[
         float,
         Field(
+            ge=0.0,
             description="Sample Rate (https://docs.sentry.io/platforms/python/configuration/sampling/#sampling-error-events)",
             default=1.0,
         ),
     ]
     traces_sample_rate: Annotated[
         float,
         Field(
+            ge=0.0,
             description="Traces Sample Rate (https://docs.sentry.io/platforms/python/configuration/sampling/#configuring-the-transaction-sample-rate)",
             default=1.0,
         ),
     ]
     profiles_sample_rate: Annotated[
         float,
         Field(
+            ge=0.0,
             description="Traces Sample Rate (https://docs.sentry.io/platforms/python/tracing/#configure)",
             default=1.0,
         ),
@@ -84,7 +89,7 @@ def sentry_initialize() -> bool:
     sentry_sdk.init(
         release=f"{__project_name__}@{__version__}",  # https://docs.sentry.io/platforms/python/configuration/releases/,
         environment=__env__,
-        dsn=settings.dsn.get_secret_value(),
+        dsn=settings.dsn.get_secret_value().strip(),
         max_breadcrumbs=settings.max_breadcrumbs,
         debug=settings.debug,
         send_default_pii=settings.send_default_pii,
diff --git a/src/oe_python_template_example/utils/_settings.py b/src/oe_python_template_example/utils/_settings.py
@@ -20,6 +20,15 @@
 UNHIDE_SENSITIVE_INFO = "unhide_sensitive_info"
 
 
+def strip_to_none_before_validator(v: str | None) -> str | None:
+    if v is None:
+        return None
+    v = v.strip()
+    if not v:
+        return None
+    return v
+
+
 class OpaqueSettings(BaseSettings):
     @staticmethod
     def serialize_sensitive_info(input_value: SecretStr, info: FieldSerializationInfo) -> str | None:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-_commit: v0.10.5`
	`1`	`+_commit: v0.10.7`
`2`	`2`	`_src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template`
`3`	`3`	`attestations_enabled: true`
`4`	`4`	`author_email: helmuthva@gmail.com`