oe-python-template-example 0.3.7__py3-none-any.whl → 0.3.8__py3-none-any.whl

oe_python_template_example/api.py

@@ -13,6 +13,7 @@ from .utils import (
     VersionedAPIRouter,
     __author_email__,
     __author_name__,
+    __base__url__,
     __documentation__url__,
     __repository_url__,
     locate_implementations,
@@ -26,6 +27,9 @@ CONTACT_EMAIL = __author_email__
 CONTACT_URL = __repository_url__
 TERMS_OF_SERVICE_URL = __documentation__url__
 
+API_BASE_URL = __base__url__
+if not API_BASE_URL:
+    API_BASE_URL = f"http://{UVICORN_HOST}:{UVICORN_PORT}"
 
 app = FastAPI(
     root_path="/api",
@@ -42,7 +46,7 @@ app = FastAPI(
             "description": f"API version {version.lstrip('v')}, check link on the right",
             "externalDocs": {
                 "description": "sub-docs",
-                "url": f"http://{UVICORN_HOST}:{UVICORN_PORT}/api/{version}/docs",
+                "url": f"{API_BASE_URL}/api/{version}/docs",
             },
         }
         for version, _ in API_VERSIONS.items()

oe_python_template_example/hello/_service.py

@@ -5,6 +5,7 @@ import string
 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 @@ class Service(BaseService):
         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

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,
+        ),
+    ]

oe_python_template_example/system/_service.py

@@ -149,7 +149,9 @@ class Service(BaseService):
         for settings_class in locate_subclasses(BaseSettings):
             settings_instance = load_settings(settings_class)
             env_prefix = settings_instance.model_config.get("env_prefix", "")
-            settings_dict = settings_instance.model_dump(context={UNHIDE_SENSITIVE_INFO: not filter_secrets})
+            settings_dict = json.loads(
+                settings_instance.model_dump_json(context={UNHIDE_SENSITIVE_INFO: not filter_secrets})
+            )
             for key, value in settings_dict.items():
                 flat_key = f"{env_prefix}{key}".upper()
                 settings[flat_key] = value

oe_python_template_example/utils/__init__.py

@@ -6,6 +6,7 @@ from ._console import console
 from ._constants import (
     __author_email__,
     __author_name__,
+    __base__url__,
     __documentation__url__,
     __env__,
     __env_file__,
@@ -23,7 +24,7 @@ from ._logfire import LogfireSettings
 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__ = [
@@ -39,6 +40,7 @@ __all__ = [
     "VersionedAPIRouter",
     "__author_email__",
     "__author_name__",
+    "__base__url__",
     "__documentation__url__",
     "__env__",
     "__env_file__",
@@ -56,4 +58,5 @@ __all__ = [
     "locate_implementations",
     "locate_subclasses",
     "prepare_cli",
+    "strip_to_none_before_validator",
 ]

oe_python_template_example/utils/_constants.py

@@ -5,6 +5,10 @@ import sys
 from importlib import metadata
 from pathlib import Path
 
+from dotenv import load_dotenv
+
+load_dotenv()
+
 __project_name__ = __name__.split(".")[0]
 __project_path__ = str(Path(__file__).parent.parent.parent)
 __version__ = metadata.version(__project_name__)
@@ -21,6 +25,13 @@ env_file_path = os.getenv(f"{__project_name__.upper()}_ENV_FILE")
 if env_file_path:
     __env_file__.insert(2, Path(env_file_path))
 
+vercel_base_url = os.getenv("VERCEL_URL", None)
+if vercel_base_url:
+    vercel_base_url = "https://" + vercel_base_url
+__base__url__ = os.getenv(__project_name__.upper() + "_BASE_URL", None)
+if not __base__url__ and vercel_base_url:
+    __base__url__ = vercel_base_url
+
 
 def get_project_url_by_label(prefix: str) -> str:
     """Get labeled Project-URL.

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),
     ]

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,12 +45,14 @@ 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,
         ),
@@ -57,6 +60,7 @@ class SentrySettings(OpaqueSettings):
     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,
         ),
@@ -64,6 +68,7 @@ class SentrySettings(OpaqueSettings):
     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,

oe_python_template_example/utils/_settings.py

@@ -20,6 +20,15 @@ logger = logging.getLogger(__name__)
 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:

{oe_python_template_example-0.3.7.dist-info → oe_python_template_example-0.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.3.7
+Version: 0.3.8
 Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/
@@ -163,7 +163,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/)
@@ -173,8 +173,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.
 

{oe_python_template_example-0.3.7.dist-info → oe_python_template_example-0.3.8.dist-info}/RECORD

@@ -1,5 +1,5 @@
 oe_python_template_example/__init__.py,sha256=_Z3Xb-x95UODU66avOiwROVaouk_s0ZNB25KFnPoS40,226
-oe_python_template_example/api.py,sha256=_DcnOEWe_MJTUWZroRnXeCh9RuBm_-x4edONWHoNBlE,2100
+oe_python_template_example/api.py,sha256=cuGqjxfJocXZBZzz4UhUeUxH4Sm79tpzc6t5G-9Lp_E,2206
 oe_python_template_example/cli.py,sha256=rNcaCyYkm5_e-ITJJLUKvJfJ_RsGXQk0dnfiFCifTq8,679
 oe_python_template_example/constants.py,sha256=fm8J1LIYF9B4Ur3r5PoUdHyPSjIXWuNydHVoCbz9Jx8,171
 oe_python_template_example/hello/__init__.py,sha256=7C7gIdxkydk79-4QPyVqyUHhqP3RMFShSptzE_2J9jo,289
@@ -7,29 +7,29 @@ oe_python_template_example/hello/_api.py,sha256=B4gCojmEkvh-ScKPz0rXW70r4gVvg7SX
 oe_python_template_example/hello/_cli.py,sha256=D1RZyz8sk7wpH1a9VDx1QtsNorOr9owxK8N7SxaaMWM,1200
 oe_python_template_example/hello/_constants.py,sha256=6aRleAIcdgC13TeTzI07YwjoSwqGb2g131dw8aEoM4I,109
 oe_python_template_example/hello/_models.py,sha256=JtI7wGT72u23NOxFa-oeWzdyiMg7PnHL5eg22im2_yQ,574
-oe_python_template_example/hello/_service.py,sha256=GPtJjGBYK1--5UPS3PcEpypHM-ka-xjDjHpDzqFHhoc,3062
-oe_python_template_example/hello/_settings.py,sha256=kvXqqYCKkT42FkiszE5MOChdsTJhC0YJfZnyLKXEtbA,992
+oe_python_template_example/hello/_service.py,sha256=o9sgk-yFX5zRi06sAOdSPqkgT93naxn-JRknwK2Nnvs,3183
+oe_python_template_example/hello/_settings.py,sha256=Q14SqSvBJYFuofA-tbvBwO30sVygSaXsgaYC7x1uCfo,1562
 oe_python_template_example/system/__init__.py,sha256=NNgODkr7AyJjTTJiv3pys7o2z6xi1G96g0vnsxVhlI4,427
 oe_python_template_example/system/_api.py,sha256=rE9Aau3IIHXdEkOBUXOwJ7SxN3cZpgtYEuojnSWfT_4,3687
 oe_python_template_example/system/_cli.py,sha256=J_4upBBdbSxbONPYmOZPbuhZcKjfnPIUeZpp0L7lY-Q,4846
-oe_python_template_example/system/_service.py,sha256=e08VPguXKz2RhyhTbIw1ncSpE6zwKUr1xLM2WZC9u7k,6287
+oe_python_template_example/system/_service.py,sha256=zdnO6e8ShgrsIK3W2KbIEYpRIp9lQw35f1UFDUn1md8,6334
 oe_python_template_example/system/_settings.py,sha256=MwMAJYifJ6jGImeSh4e9shmIXmiUSuQGHXz_Ts0mSdk,901
-oe_python_template_example/utils/__init__.py,sha256=rHdmSS21CtvF3AXPMSCZO17FTzxPDo-NiKZ5AjVU9b0,1449
+oe_python_template_example/utils/__init__.py,sha256=MVy9A4miNYBFkNc0f24-KGG25mftb8BzDmyBb43lvQE,1559
 oe_python_template_example/utils/_api.py,sha256=w3hPQK1pL2gBI4_1qNWNa2b4S_oH-8mY-ckRX0KrCWM,617
 oe_python_template_example/utils/_cli.py,sha256=J_mFtXZ1gGeovGrE5i3wlokTOBfiTTKEz5magiRP7GA,2091
 oe_python_template_example/utils/_console.py,sha256=u0-utcdRmVu4rabrYUyNOx8yPxLhxB3E92m22kSCwPQ,293
-oe_python_template_example/utils/_constants.py,sha256=1ocbciHjhmy66uHrTw6p-fbBq_wLl1HaUSu4oTgt8mo,1737
+oe_python_template_example/utils/_constants.py,sha256=AP1a4kJqyf3HG6YFupUREvlkTX1b-Xx1H4u0O1nMfzc,2054
 oe_python_template_example/utils/_di.py,sha256=KdjiD4xZ_QSfbddkKWwsPJmG5YrIg6dzuBrlsd-FhxA,2189
 oe_python_template_example/utils/_health.py,sha256=35QOWe2r5InrEpGtuVMym9dI5aRHS0HWf4BHBRAUIj0,4102
 oe_python_template_example/utils/_log.py,sha256=ZW4gs540SdjVK-2KeheLfDY15d_3xpO5FyGn7wTXyaM,3592
-oe_python_template_example/utils/_logfire.py,sha256=g2tR60XgpdRs_UwDpqkwWm6ErUBcV7lPFBJdvgfTuu0,2022
+oe_python_template_example/utils/_logfire.py,sha256=wZYNVowQx7kh3XJoJ59FjUKdrta7tp6cXOJRUT6lDU8,2128
 oe_python_template_example/utils/_process.py,sha256=40R0NZMqJUn0iUPERzohSUpJgU1HcJApIg1HipIxFCw,941
-oe_python_template_example/utils/_sentry.py,sha256=Y4hZ-PeBOdR3iRhoXW9j0tbWsYf07460UG8OVTKH1mU,3128
+oe_python_template_example/utils/_sentry.py,sha256=2sXrDSZSYoDEM87v7CakJ6eGBtcIhDI48PsQCLwOHgg,3319
 oe_python_template_example/utils/_service.py,sha256=atHAejvBucKXjzhsMSdOBBFa7rRD74zcV70Pp0pl0Tg,1038
-oe_python_template_example/utils/_settings.py,sha256=5K1pnp-AxMQbktREb3bXDmqgrOx_L4EJIgjPQfqH4sE,2294
+oe_python_template_example/utils/_settings.py,sha256=owFoaHEzJnVD3EVyOWF4rfIY7g6eLnU6rN0m4VHhCbA,2464
 oe_python_template_example/utils/boot.py,sha256=TBgmqbtIryQz0cAozYzxhYQRIldfbJ6v9R-rH6sO9mY,2696
-oe_python_template_example-0.3.7.dist-info/METADATA,sha256=fHz4k1yEXUdTCmimGQ3ANZQ4e5kWKxxO5vZ4Gb2VqZE,33191
-oe_python_template_example-0.3.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template_example-0.3.7.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
-oe_python_template_example-0.3.7.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template_example-0.3.7.dist-info/RECORD,,
+oe_python_template_example-0.3.8.dist-info/METADATA,sha256=A29u6dC905uIKGAxEMZAWb8aZpaF8JeRpX0GUnUc7eU,33326
+oe_python_template_example-0.3.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template_example-0.3.8.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
+oe_python_template_example-0.3.8.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template_example-0.3.8.dist-info/RECORD,,