cwyodmodules 0.3.54__py3-none-any.whl → 0.3.55__py3-none-any.whl

cwyodmodules/mgmt_config.py

@@ -0,0 +1,209 @@
+"""
+Azure Project Management Configuration Template
+
+This template provides standardized configuration for Azure logging and identity
+management across projects. It creates singleton instances of AzureLogger and
+AzureIdentity that can be imported and used throughout your application.
+
+Usage:
+    from mgmt_config import logger, identity
+    
+    logger.info("Application started")
+    credential = identity.get_credential()
+"""
+
+import os
+from typing import Optional, Dict, Any
+from azpaddypy.mgmt.logging import create_app_logger, create_function_logger
+from azpaddypy.mgmt.identity import create_azure_identity
+from azpaddypy.resources.keyvault import create_azure_keyvault
+from azpaddypy.mgmt.local_env_manager import create_local_env_manager
+
+# Alias for import in other packages
+
+# =============================================================================
+# SERVICE CONFIGURATION
+# =============================================================================
+
+# Service identity - customize these for your project
+SERVICE_NAME = os.getenv("SERVICE_NAME", __name__)
+SERVICE_VERSION = os.getenv("SERVICE_VERSION", "1.0.0")
+
+# =============================================================================
+# LOGGING CONFIGURATION
+# =============================================================================
+
+# Enable console output (useful for local development)
+LOGGER_ENABLE_CONSOLE = os.getenv("LOGGER_ENABLE_CONSOLE", "true").lower() == "true"
+
+# Application Insights connection string (optional, will use environment variable if not set)
+LOGGER_CONNECTION_STRING = os.getenv("APPLICATIONINSIGHTS_CONNECTION_STRING")
+
+# Local development settings
+LOCAL_SETTINGS = {
+    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
+    "AzureWebJobsDashboard": "UseDevelopmentStorage=true",
+    "input_queue_connection__queueServiceUri":  "UseDevelopmentStorage=true",
+    "AzureWebJobsStorage__accountName":  "UseDevelopmentStorage=true",
+    "AzureWebJobsStorage__blobServiceUri":  "UseDevelopmentStorage=true",
+    "AZURE_CLIENT_ID": "aa73da4a-2888-4cb7-896e-5d51125f11f0"
+}
+
+# Configure which Azure SDK components to instrument
+LOGGER_INSTRUMENTATION_OPTIONS = {
+    "azure_sdk": {"enabled": True},
+    "django": {"enabled": False},
+    "fastapi": {"enabled": False},
+    "flask": {"enabled": True},
+    "psycopg2": {"enabled": True},
+    "requests": {"enabled": True},
+    "urllib": {"enabled": True},
+    "urllib3": {"enabled": True},
+}
+
+# =============================================================================
+# IDENTITY CONFIGURATION
+# =============================================================================
+
+# Token caching settings
+IDENTITY_ENABLE_TOKEN_CACHE = os.getenv("IDENTITY_ENABLE_TOKEN_CACHE", "true").lower() == "true"
+IDENTITY_ALLOW_UNENCRYPTED_STORAGE = os.getenv("IDENTITY_ALLOW_UNENCRYPTED_STORAGE", "true").lower() == "true"
+
+# Custom credential options (None means use defaults)
+IDENTITY_CUSTOM_CREDENTIAL_OPTIONS: Optional[Dict[str, Any]] = None
+
+# Connection string for identity logging (uses same as logger by default)
+IDENTITY_CONNECTION_STRING = LOGGER_CONNECTION_STRING
+
+# =============================================================================
+# KEYVAULT CONFIGURATION
+# =============================================================================
+
+# Azure Key Vault URL (required for Key Vault operations)
+KEYVAULT_URL = os.getenv("key_vault_uri")
+HEAD_KEYVAULT_URL = os.getenv("head_key_vault_uri")
+
+# Enable specific Key Vault client types
+KEYVAULT_ENABLE_SECRETS = os.getenv("KEYVAULT_ENABLE_SECRETS", "true").lower() == "true"
+KEYVAULT_ENABLE_KEYS = os.getenv("KEYVAULT_ENABLE_KEYS", "false").lower() == "true"
+KEYVAULT_ENABLE_CERTIFICATES = os.getenv("KEYVAULT_ENABLE_CERTIFICATES", "false").lower() == "true"
+
+# Connection string for keyvault logging (uses same as logger by default)
+KEYVAULT_CONNECTION_STRING = LOGGER_CONNECTION_STRING
+
+# =============================================================================
+# INITIALIZE SERVICES
+# =============================================================================
+
+# Create logger instance
+logger = create_function_logger(
+    function_app_name=os.getenv("REFLECTION_NAME", "app"),
+    function_name=os.getenv("REFLECTION_KIND", "app"),
+    service_version=SERVICE_VERSION,
+    connection_string=LOGGER_CONNECTION_STRING,
+    instrumentation_options=LOGGER_INSTRUMENTATION_OPTIONS,
+)
+logger.info("Function logger initialized")
+
+# Create local development settings instance
+local_env_manager = create_local_env_manager(
+    file_path=".env",
+    settings=LOCAL_SETTINGS,
+    logger=logger,
+    override_json=True,
+    override_dotenv=True,
+    override_settings=True,
+)
+
+# Create identity instance with shared logger
+identity = create_azure_identity(
+    service_name=SERVICE_NAME,
+    service_version=SERVICE_VERSION,
+    enable_token_cache=IDENTITY_ENABLE_TOKEN_CACHE,
+    allow_unencrypted_storage=IDENTITY_ALLOW_UNENCRYPTED_STORAGE,
+    custom_credential_options=IDENTITY_CUSTOM_CREDENTIAL_OPTIONS,
+    connection_string=IDENTITY_CONNECTION_STRING,
+    logger=logger,
+)
+
+# Create keyvault instance with shared logger and identity (if URL is configured)
+keyvault = None
+if KEYVAULT_URL:
+    keyvault = create_azure_keyvault(
+        vault_url=KEYVAULT_URL,
+        azure_identity=identity,
+        service_name=SERVICE_NAME,
+        service_version=SERVICE_VERSION,
+        logger=logger,
+        connection_string=KEYVAULT_CONNECTION_STRING,
+        enable_secrets=KEYVAULT_ENABLE_SECRETS,
+        enable_keys=KEYVAULT_ENABLE_KEYS,
+        enable_certificates=KEYVAULT_ENABLE_CERTIFICATES,
+    )
+
+head_keyvault = None
+if HEAD_KEYVAULT_URL:
+    head_keyvault = create_azure_keyvault(
+        vault_url=HEAD_KEYVAULT_URL,
+        azure_identity=identity,
+        service_name=SERVICE_NAME,
+        service_version=SERVICE_VERSION,
+        logger=logger,
+        connection_string=KEYVAULT_CONNECTION_STRING,
+        enable_secrets=KEYVAULT_ENABLE_SECRETS,
+        enable_keys=KEYVAULT_ENABLE_KEYS,
+        enable_certificates=KEYVAULT_ENABLE_CERTIFICATES,
+    )
+
+# =============================================================================
+# VALIDATION & STARTUP
+# =============================================================================
+
+# Validate critical configuration
+if SERVICE_NAME == __name__:
+    logger.warning(
+        "SERVICE_NAME is not configured. Please set SERVICE_NAME environment variable or update this template.",
+        extra={"configuration_issue": "service_name_not_set"}
+    )
+
+if not LOGGER_CONNECTION_STRING:
+    logger.info(
+        "No Application Insights connection string configured. Telemetry will be disabled.",
+        extra={"telemetry_status": "disabled"}
+    )
+
+if not KEYVAULT_URL:
+    logger.info(
+        "No Key Vault URL configured. Key Vault operations will be disabled.",
+        extra={"keyvault_status": "disabled"}
+    )
+
+if not HEAD_KEYVAULT_URL:
+    logger.info(
+        "No Head Key Vault URL configured. Head Key Vault operations will be disabled.",
+        extra={"head_keyvault_status": "disabled"}
+    )
+
+# Log successful initialization
+logger.info(
+    f"Management configuration initialized for service '{SERVICE_NAME}' v{SERVICE_VERSION}",
+    extra={
+        "service_name": SERVICE_NAME,
+        "service_version": SERVICE_VERSION,
+        "console_logging": LOGGER_ENABLE_CONSOLE,
+        "token_cache_enabled": IDENTITY_ENABLE_TOKEN_CACHE,
+        "telemetry_enabled": bool(LOGGER_CONNECTION_STRING),
+        "keyvault_enabled": bool(KEYVAULT_URL),
+        "head_keyvault_enabled": bool(HEAD_KEYVAULT_URL),
+        "keyvault_secrets_enabled": KEYVAULT_ENABLE_SECRETS if KEYVAULT_URL else False,
+        "keyvault_keys_enabled": KEYVAULT_ENABLE_KEYS if KEYVAULT_URL else False,
+        "keyvault_certificates_enabled": KEYVAULT_ENABLE_CERTIFICATES if KEYVAULT_URL else False,
+    }
+)
+
+# =============================================================================
+# EXPORTS
+# =============================================================================
+
+# Export logger, identity, and keyvault for use in applications
+__all__ = ["logger", "local_env_manager", "identity", "keyvault", "head_keyvault"]

{cwyodmodules-0.3.54.dist-info → cwyodmodules-0.3.55.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cwyodmodules
-Version: 0.3.54
+Version: 0.3.55
 Summary: Add your description here
 Author-email: Patrik <patrikhartl@gmail.com>
 Classifier: Operating System :: OS Independent

{cwyodmodules-0.3.54.dist-info → cwyodmodules-0.3.55.dist-info}/RECORD

@@ -1,4 +1,5 @@
 cwyodmodules/__init__.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+cwyodmodules/mgmt_config.py,sha256=8_44C151sT6sFrxjygWVhevVg4Wi0jVU9va8XLHvY7Y,8405
 cwyodmodules/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cwyodmodules/api/chat_history.py,sha256=bVXFmhTHIfEiHv_nBrfizO-cQRHhKgrdcZ07OD1b0Tw,20683
 cwyodmodules/batch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -108,8 +109,8 @@ cwyodmodules/graphrag/query/generate.py,sha256=BZiB6iw7PkIovw-CyYFogMHnDxK0Qu_4u
 cwyodmodules/graphrag/query/graph_search.py,sha256=95h3ecSWx4864XgKABtG0fh3Nk8HkqJVzoCrO8daJ-Y,7724
 cwyodmodules/graphrag/query/types.py,sha256=1Iq1dp4I4a56_cuFjOZ0NTgd0A2_MpVFznp_czgt6cI,617
 cwyodmodules/graphrag/query/vector_search.py,sha256=9Gwu9LPjtoAYUU8WKqCvbCHAIg3dpk71reoYd1scLnQ,1807
-cwyodmodules-0.3.54.dist-info/licenses/LICENSE,sha256=UqBDTipijsSW2ZSOXyTZnMsXmLoEHTgNEM0tL4g-Sso,1150
-cwyodmodules-0.3.54.dist-info/METADATA,sha256=LhGfHbxAwWGDOuAs15TF_cMOjY9_ry3xI02pfIy5p2k,2002
-cwyodmodules-0.3.54.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cwyodmodules-0.3.54.dist-info/top_level.txt,sha256=99RENLbkdRX-qpJvsxZ5AfmTL5s6shSaKOWYpz1vwzg,13
-cwyodmodules-0.3.54.dist-info/RECORD,,
+cwyodmodules-0.3.55.dist-info/licenses/LICENSE,sha256=UqBDTipijsSW2ZSOXyTZnMsXmLoEHTgNEM0tL4g-Sso,1150
+cwyodmodules-0.3.55.dist-info/METADATA,sha256=OD9JKPHxXcaAQGblPWbMjjqaeVPXcD2ZV_-OT1KNzaU,2002
+cwyodmodules-0.3.55.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cwyodmodules-0.3.55.dist-info/top_level.txt,sha256=99RENLbkdRX-qpJvsxZ5AfmTL5s6shSaKOWYpz1vwzg,13
+cwyodmodules-0.3.55.dist-info/RECORD,,