processcube-etw-library 2026.1.22.73503b0__py3-none-any.whl → 2026.1.22.120215b0__py3-none-any.whl

processcube_etw_library/__init__.py

@@ -11,7 +11,7 @@ from .health import (
     LivezResponse,
 )
 from .etw_app import new_external_task_worker_app
-from .settings import get_settings, init_settings
+from .settings import load_settings, load_settings
 
 __all__ = [
     "create_url_health_check",
@@ -21,6 +21,5 @@ __all__ = [
     "HealthConditionInfo",
     "LivezResponse",
     "new_external_task_worker_app",
-    "get_settings",
-    "init_settings",
+    "load_settings",
 ]

processcube_etw_library/create_external_task_client.py

@@ -5,11 +5,11 @@
 from processcube_client.external_task import ExternalTaskClient
 
 from .identity_provider import IdentityProvider
-from .settings import get_settings
+from .settings import load_settings
 
 
 def create_external_task_client() -> ExternalTaskClient:
-    settings = get_settings()
+    settings = load_settings()
     authority_url = settings.processcube_authority_url
     engine_url = settings.processcube_engine_url
     client_name = settings.processcube_etw_client_id

processcube_etw_library/etw_app.py

@@ -15,7 +15,6 @@ from .health import (
 from .create_external_task_client import create_external_task_client
 from .server_config import get_server_config
 from .typed_handler import create_typed_handler_wrapper
-from .settings import get_settings
 from processcube_client.external_task import ExternalTaskClient
 
 
@@ -92,8 +91,6 @@ class ExternalTaskWorkerApp:
 def new_external_task_worker_app(
     built_in_health_checks: bool = True,
 ) -> ExternalTaskWorkerApp:
-    settings = get_settings()
-
     external_task_client = create_external_task_client()
 
     return ExternalTaskWorkerApp(

processcube_etw_library/health/built_in.py

@@ -1,10 +1,10 @@
-from ..settings import get_settings
+from ..settings import load_settings
 from .check import HealthCheck, create_url_health_check
 from .registry import HealthCheckRegistry
 
 
 def add_built_in_health_checks(registry: HealthCheckRegistry) -> None:
-    settings = get_settings()
+    settings = load_settings()
 
     engine_url = (
         settings.processcube_engine_url.strip("/")

processcube_etw_library/server_config.py

@@ -1,6 +1,6 @@
 from typing import TypedDict
 
-from .settings import get_settings
+from .settings import load_settings
 
 
 class ServerConfig(TypedDict, total=False):
@@ -12,7 +12,7 @@ class ServerConfig(TypedDict, total=False):
 
 
 def get_server_config() -> ServerConfig:
-    settings = get_settings()
+    settings = load_settings()
 
     if settings.environment == "production":
         return ServerConfig(

processcube_etw_library/settings.py

@@ -44,8 +44,8 @@ class ETWSettings(BaseSettings):
         class MySettings(ETWSettings):
             my_custom_var: str = Field(default="default_value")
 
-        # Initialize with custom settings class
-        init_settings(MySettings)
+        # Load with custom settings class
+        settings = load_settings(MySettings)
     """
 
     model_config = SettingsConfigDict(
@@ -89,29 +89,18 @@ class ETWSettings(BaseSettings):
 _settings: Optional[ETWSettings] = None
 
 
-def init_settings(settings_class: Type[T] = ETWSettings) -> T:
-    """
-    Initialize the global settings instance.
 
+def load_settings(settings_class: Type[T] = ETWSettings) -> T:
+    """
     Call this with a custom settings class to extend the base settings:
 
         class MySettings(ETWSettings):
             my_var: str = Field(default="value")
 
-        init_settings(MySettings)
+        settings = load_settings(MySettings)
     """
-    global _settings
-    _settings = settings_class()
-    return _settings
-
 
-def get_settings() -> ETWSettings:
-    """
-    Get the global settings instance.
-
-    If settings haven't been initialized, creates a default ETWSettings instance.
-    """
     global _settings
     if _settings is None:
-        _settings = ETWSettings()
-    return _settings
+        _settings = settings_class()
+    return _settings # type: ignore

processcube_etw_library-2026.1.22.120215b0.dist-info/METADATA

@@ -0,0 +1,197 @@
+Metadata-Version: 2.4
+Name: processcube-etw-library
+Version: 2026.1.22.120215b0
+Summary: A library to create ETW apps with the ProcessCube platform.
+Author-email: Jeremy Hill <jeremy.hill@profection.de>
+License: MIT
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi[standard]>=0.128.0
+Requires-Dist: oauth2-client>=1.4.2
+Requires-Dist: processcube-client>=5.0.0
+Requires-Dist: tenacity>=9.1.2
+
+# ProcessCube ETW Library
+
+Build External Task Workers (ETW) for ProcessCube, featuring health checks, typed handlers, and environment-based configuration.
+
+## Installation
+
+```bash
+uv add processcube-etw-library
+```
+
+## Configuration
+
+### Environment Variables
+
+The library uses environment variables for configuration. You can set these in your environment or in a `.env` file in your project root.
+
+| Variable                             | Default                                | Description                                      |
+| ------------------------------------ | -------------------------------------- | ------------------------------------------------ |
+| `PROCESSCUBE_ENGINE_URL`             | `http://localhost:56000`               | URL of the ProcessCube Engine                    |
+| `PROCESSCUBE_AUTHORITY_URL`          | Auto-discovered from engine            | URL of the ProcessCube Authority (OAuth server)  |
+| `PROCESSCUBE_ETW_CLIENT_ID`          | `test_etw`                             | OAuth client ID for the External Task Worker     |
+| `PROCESSCUBE_ETW_CLIENT_SECRET`      | `3ef62eb3-fe49-4c2c-ba6f-73e4d234321b` | OAuth client secret for the External Task Worker |
+| `PROCESSCUBE_ETW_CLIENT_SCOPES`      | `engine_etw`                           | OAuth scopes for the External Task Worker        |
+| `MAX_GET_OAUTH_ACCESS_TOKEN_RETRIES` | `10`                                   | Maximum retries for obtaining OAuth access token |
+| `ENVIRONMENT`                        | `development`                          | Environment mode (`development` or `production`) |
+
+#### Example `.env` File
+
+```env
+PROCESSCUBE_ENGINE_URL=http://localhost:56000
+PROCESSCUBE_ETW_CLIENT_ID=my_etw_client
+PROCESSCUBE_ETW_CLIENT_SECRET=my_secret_key
+PROCESSCUBE_ETW_CLIENT_SCOPES=engine_etw
+ENVIRONMENT=production
+```
+
+### Extending Settings
+
+You can extend the base settings class to add your own environment variables:
+
+```python
+from pydantic import Field
+from processcube_etw_library.settings import ETWSettings, load_settings
+
+class MyAppSettings(ETWSettings):
+    database_url: str = Field(default="sqlite:///app.db")
+    api_key: str = Field(default="")
+
+# Load settings with your custom class
+settings = load_settings(MyAppSettings)
+```
+
+## Usage
+
+### Start the ETW Application
+
+```python
+from processcube_etw_library import new_external_task_worker_app
+
+# Create the application
+app = new_external_task_worker_app()
+
+# Run the application
+app.run()
+```
+
+### Subscribe to External Task Topics
+
+```python
+from processcube_etw_library import new_external_task_worker_app
+
+app = new_external_task_worker_app()
+
+def my_handler(task):
+    # Process the task
+    result = {"processed": True}
+    return result
+
+# Subscribe to a topic
+app.subscribe_to_external_task_for_topic("my-topic", my_handler)
+
+app.run()
+```
+
+### Typed Handlers
+
+Use typed handlers for automatic payload validation with Pydantic models:
+
+```python
+from pydantic import BaseModel
+from processcube_etw_library import new_external_task_worker_app
+
+class MyInput(BaseModel):
+    name: str
+    value: int
+
+class MyOutput(BaseModel):
+    result: str
+
+app = new_external_task_worker_app()
+
+def my_typed_handler(payload: MyInput) -> MyOutput:
+    return MyOutput(result=f"Processed {payload.name} with value {payload.value}")
+
+app.subscribe_to_external_task_for_topic_typed("my-typed-topic", my_typed_handler)
+
+app.run()
+```
+
+### Add a Custom Health Check
+
+```python
+from processcube_etw_library import new_external_task_worker_app
+from processcube_etw_library.health import HealthCheck, create_url_health_check
+
+app = new_external_task_worker_app()
+
+# Add a URL-based health check
+app.add_health_check(
+    HealthCheck(
+        create_url_health_check("http://my-service:8080/health"),
+        service_name="My Service",
+        tags=["backend", "api"],
+        comments=["Checks if My Service is reachable"],
+    )
+)
+
+# Add a custom health check function
+def check_database():
+    # Return True if healthy, False otherwise
+    try:
+        # Your database check logic here
+        return True
+    except Exception:
+        return False
+
+app.add_health_check(
+    HealthCheck(
+        check_database,
+        service_name="Database",
+        tags=["backend", "database"],
+        comments=["Checks database connectivity"],
+    )
+)
+
+app.run()
+```
+
+### Managing Health Checks
+
+```python
+# Get all registered health checks
+checks = app.get_health_checks()
+
+# Get a specific health check by service name
+db_check = app.get_health_check("Database")
+
+# Remove a health check
+app.remove_health_check("Database")
+```
+
+### Disabling Built-in Health Checks
+
+By default, the library registers health checks for the ProcessCube Engine and Authority. You can disable these:
+
+```python
+app = new_external_task_worker_app(built_in_health_checks=False)
+```
+
+## Health Endpoints
+
+The application exposes health endpoints at `/healthyz` and `/readyz` that return the status of all registered health checks.
+To check if the application is running without performing health checks, use `/livez`.
+
+## Server Configuration
+
+The server configuration is determined by the `ENVIRONMENT` variable:
+
+| Setting    | Development | Production |
+| ---------- | ----------- | ---------- |
+| Host       | `0.0.0.0`   | `0.0.0.0`  |
+| Port       | `8000`      | `8000`     |
+| Log Level  | `debug`     | `warning`  |
+| Access Log | `true`      | `false`    |

processcube_etw_library-2026.1.22.120215b0.dist-info/RECORD

@@ -0,0 +1,18 @@
+processcube_etw_library/__init__.py,sha256=-Kf99BVV-XUw9xJBAmDoZRcFH0BUp3jGOMQA0on2sNI,662
+processcube_etw_library/create_external_task_client.py,sha256=nxrZh5U7PkSkx6vLLrcLCPpEBzZv11CGfb6cXIXSXog,1112
+processcube_etw_library/etw_app.py,sha256=CiRvZC5N6lSfu_IDoKmrAgCkS4xZpIll-QAaObRfGos,3260
+processcube_etw_library/identity_provider.py,sha256=X33lOEPrB-HaZGc5DjTSPHynU7EdbTVFJ6vPg0K_boc,2785
+processcube_etw_library/server_config.py,sha256=qgKiNjgf2GzteZ1rAdSLH8GHt_i9rVpy32ttvKI4CGA,630
+processcube_etw_library/settings.py,sha256=06OeG9oT73XlNfa2uK17J1_HwFJ_mKWyyCzv4uiUB9I,3691
+processcube_etw_library/typed_handler.py,sha256=ipfKK09D4zP8exz9PnMRBj2hSVJwJFS85v7x7h9IGrs,1670
+processcube_etw_library/health/__init__.py,sha256=-x-XcvovAF-4CIGFY_SaxBGz60tPg3VoPMavxvOWxQ4,588
+processcube_etw_library/health/built_in.py,sha256=nix40LwD8vPzsTLzVqvjvc1V8oLPvJnARWedhhYRbx8,1022
+processcube_etw_library/health/check.py,sha256=2NiyMXsHCZmB9KD5XB3PprpgJK1HFblM-E9c1Ermt2E,1335
+processcube_etw_library/health/handlers.py,sha256=iP9PIM1n_dfdwY8uFpxlbwe7oUNsch9Pg2AYI4SN8RY,1423
+processcube_etw_library/health/models.py,sha256=mSDCaPvRjwddP41E05vbplk8abvemygj75FmmnAS65g,1529
+processcube_etw_library/health/registry.py,sha256=h3ThPts9xTdnzuJeIpL_aG6xhI1DAHyaXXE3UzkiLWU,955
+processcube_etw_library/health/routes.py,sha256=9zbi1TkPUP7t8hLu32IvS3tGBfSm7dkmEDxdwaM6JX4,754
+processcube_etw_library-2026.1.22.120215b0.dist-info/METADATA,sha256=Mw78ZTWzizuYSAQmAQVzAPG0G-zIN9KbVYC-wRMPfEU,5836
+processcube_etw_library-2026.1.22.120215b0.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+processcube_etw_library-2026.1.22.120215b0.dist-info/top_level.txt,sha256=4PHR_mnrU9J-d4zMU4XHDSmB7BURAAryRmBgbuypSuI,24
+processcube_etw_library-2026.1.22.120215b0.dist-info/RECORD,,

processcube_etw_library-2026.1.22.73503b0.dist-info/METADATA

@@ -1,24 +0,0 @@
-Metadata-Version: 2.4
-Name: processcube-etw-library
-Version: 2026.1.22.73503b0
-Summary: A library to create ETW apps with the ProcessCube platform.
-Author-email: Jeremy Hill <jeremy.hill@profection.de>
-License: MIT
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-Requires-Dist: fastapi[standard]>=0.128.0
-Requires-Dist: oauth2-client>=1.4.2
-Requires-Dist: processcube-client>=5.0.0
-Requires-Dist: tenacity>=9.1.2
-
-# ProcessCube ETW Library
-
-## Installation
-
-## Usage
-
-### Start the ETW application
-
-### Subscribe to External Task Topics
-
-### Add a custom health check

processcube_etw_library-2026.1.22.73503b0.dist-info/RECORD

@@ -1,18 +0,0 @@
-processcube_etw_library/__init__.py,sha256=B6b63RPPlkbf-X0nJVugzzCHehBwItWr3tmJ37J9WCo,681
-processcube_etw_library/create_external_task_client.py,sha256=aB0AgWNEipRJP8HXY92uJjEYuhJo_47g3VyU2mQtPgY,1110
-processcube_etw_library/etw_app.py,sha256=FWWhqMHqQex2pShYDi9FD2PTyiHkbR2yebWJxpQXKyU,3326
-processcube_etw_library/identity_provider.py,sha256=X33lOEPrB-HaZGc5DjTSPHynU7EdbTVFJ6vPg0K_boc,2785
-processcube_etw_library/server_config.py,sha256=z_x9NZX6Hz2KdN4cNu__2tn10sOSZ9xIAkpLnlnIy84,628
-processcube_etw_library/settings.py,sha256=sdangsMXIqpjEGRtlU-AVddFXzDTcg_rrIZxyO_IogM,3950
-processcube_etw_library/typed_handler.py,sha256=ipfKK09D4zP8exz9PnMRBj2hSVJwJFS85v7x7h9IGrs,1670
-processcube_etw_library/health/__init__.py,sha256=-x-XcvovAF-4CIGFY_SaxBGz60tPg3VoPMavxvOWxQ4,588
-processcube_etw_library/health/built_in.py,sha256=0PWJySskJ-h6dHIlH-IjYbR5jAQDXbLrBg7dhHW_H_4,1020
-processcube_etw_library/health/check.py,sha256=2NiyMXsHCZmB9KD5XB3PprpgJK1HFblM-E9c1Ermt2E,1335
-processcube_etw_library/health/handlers.py,sha256=iP9PIM1n_dfdwY8uFpxlbwe7oUNsch9Pg2AYI4SN8RY,1423
-processcube_etw_library/health/models.py,sha256=mSDCaPvRjwddP41E05vbplk8abvemygj75FmmnAS65g,1529
-processcube_etw_library/health/registry.py,sha256=h3ThPts9xTdnzuJeIpL_aG6xhI1DAHyaXXE3UzkiLWU,955
-processcube_etw_library/health/routes.py,sha256=9zbi1TkPUP7t8hLu32IvS3tGBfSm7dkmEDxdwaM6JX4,754
-processcube_etw_library-2026.1.22.73503b0.dist-info/METADATA,sha256=hN_KpjDDTHeWsYAhx4VBwX5LI98XRANezjbddno8x_4,584
-processcube_etw_library-2026.1.22.73503b0.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
-processcube_etw_library-2026.1.22.73503b0.dist-info/top_level.txt,sha256=4PHR_mnrU9J-d4zMU4XHDSmB7BURAAryRmBgbuypSuI,24
-processcube_etw_library-2026.1.22.73503b0.dist-info/RECORD,,