clarity-api-sdk-python 0.3.18__tar.gz → 0.3.20__tar.gz

{clarity_api_sdk_python-0.3.18 → clarity_api_sdk_python-0.3.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.18
+Version: 0.3.20
 Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
@@ -88,6 +88,9 @@ logger_a.warning("This is a new warning message from logger_a.")
 
 logger_b.info("This info message from logger_b should NOT be visible.")
 logger_b.warning("This is warning message from logger_b")
+
+# the value will be redacted
+logger_b.info("password", extra={"aws_access_key_id", "AKIAIOSFODNN7EXAMPLE"})
 ```
 
 ## Model

{clarity_api_sdk_python-0.3.18 → clarity_api_sdk_python-0.3.20}/README.md

@@ -54,6 +54,9 @@ logger_a.warning("This is a new warning message from logger_a.")
 
 logger_b.info("This info message from logger_b should NOT be visible.")
 logger_b.warning("This is warning message from logger_b")
+
+# the value will be redacted
+logger_b.info("password", extra={"aws_access_key_id", "AKIAIOSFODNN7EXAMPLE"})
 ```
 
 ## Model

{clarity_api_sdk_python-0.3.18 → clarity_api_sdk_python-0.3.20}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clarity-api-sdk-python"
-version = "0.3.18"
+version = "0.3.20"
 authors = [
   { name="Chesapeake Technology Inc.", email="support@chesapeaketech.com" },
 ]

{clarity_api_sdk_python-0.3.18 → clarity_api_sdk_python-0.3.20}/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.18
+Version: 0.3.20
 Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
@@ -88,6 +88,9 @@ logger_a.warning("This is a new warning message from logger_a.")
 
 logger_b.info("This info message from logger_b should NOT be visible.")
 logger_b.warning("This is warning message from logger_b")
+
+# the value will be redacted
+logger_b.info("password", extra={"aws_access_key_id", "AKIAIOSFODNN7EXAMPLE"})
 ```
 
 ## Model

{clarity_api_sdk_python-0.3.18 → clarity_api_sdk_python-0.3.20}/src/clarity_api_sdk_python.egg-info/SOURCES.txt

@@ -17,6 +17,7 @@ src/cti/logger/logger.py
 src/cti/model/__init__.py
 src/cti/model/altitude_source.py
 src/cti/model/attitude_source.py
+src/cti/model/deferred_object_deletion.py
 src/cti/model/depth_source.py
 src/cti/model/device.py
 src/cti/model/device_type.py
@@ -43,6 +44,7 @@ src/cti/model/raw_attitude.py
 src/cti/model/raw_depth.py
 src/cti/model/raw_file.py
 src/cti/model/raw_file_configuration.py
+src/cti/model/raw_file_state.py
 src/cti/model/raw_layback.py
 src/cti/model/raw_position.py
 src/cti/model/raw_sidescan_ping.py

{clarity_api_sdk_python-0.3.18 → clarity_api_sdk_python-0.3.20}/src/cti/logger/logger.py

@@ -143,7 +143,23 @@ def _secret_redaction_processor(_, __, event_dict):
     Returns:
         structlog.typing.EventDict: The processed event dictionary.
     """
-    sensitive_keys = ["password", "api_key", "token", "SecretString", "key", "auth"]
+    sensitive_keys = {
+        "access_token",
+        "api_key",
+        "auth",
+        "authorization",
+        "aws_access_key_id",
+        "aws_secret_access_key",
+        "aws_session_token",
+        "credentials",
+        "key",
+        "keycloak_client_id",
+        "keycloak_client_secret",
+        "password",
+        "secret",
+        "secretstring",
+        "token",
+    }
 
     def redact_dict(data):
         """Recursively redact sensitive keys in nested dictionaries.
@@ -155,22 +171,16 @@ def _secret_redaction_processor(_, __, event_dict):
             dict: The redacted dictionary.
         """
         if isinstance(data, dict):
-            for key, value in data.items():
-                if key in sensitive_keys:
+            # Use a copy of items to allow modification during iteration
+            for key, value in list(data.items()):
+                if key.lower() in sensitive_keys:
                     data[key] = "[REDACTED]"
                 elif isinstance(value, dict):
                     redact_dict(value)
         return data
 
-    # Redact top-level sensitive keys
-    for key in sensitive_keys:
-        if key in event_dict:
-            event_dict[key] = "[REDACTED]"
-
-    # Check for nested dictionaries and redact them
-    for key, value in event_dict.items():
-        if isinstance(value, dict):
-            redact_dict(value)
+    # Redact top-level and nested keys
+    redact_dict(event_dict)
 
     return event_dict
 

clarity_api_sdk_python-0.3.20/src/cti/model/deferred_object_deletion.py

@@ -0,0 +1,36 @@
+"""Pydantic models for deferred object deletion."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+
+class DeferredObjectDeletionBase(BaseModel):
+    """Base model for deferred object deletion.
+
+    Attributes:
+        uri: URI for AWS S3 object, Azure Storage Blob, etc.
+    """
+
+    uri: str
+
+
+class DeferredObjectDeletionCreate(DeferredObjectDeletionBase):
+    """Model for creating a deferred object deletion entry."""
+
+
+class DeferredObjectDeletion(DeferredObjectDeletionBase):
+    """Model for deferred object deletion data with database fields.
+
+    Attributes:
+        deferred_object_deletion_id: Unique identifier for the deferred object deletion.
+        updated_by: User who initiated the deletion.
+        created_date: Date and time when the deletion request was initiated.
+    """
+
+    deferred_object_deletion_id: UUID
+    updated_by: str
+    created_date: datetime
+
+    model_config = ConfigDict(from_attributes=True)

{clarity_api_sdk_python-0.3.18 → clarity_api_sdk_python-0.3.20}/src/cti/model/raw_file.py

@@ -1,18 +1,11 @@
 """Pydantic models for raw file. This is the data that has been uploaded but not ingested into the database."""
 
 from datetime import datetime
-from enum import Enum
 from uuid import UUID
 
 from pydantic import BaseModel, ConfigDict, field_validator
 
-
-class RawFileState(str, Enum):
-    """State of a raw file upload."""
-
-    UPLOADING = "uploading"
-    READY = "ready"
-    ERROR = "error"
+from model.raw_file_state import RawFileState
 
 
 class RawFileBase(BaseModel):
@@ -52,17 +45,9 @@ class RawFileBase(BaseModel):
 class RawFileCreate(RawFileBase):
     """Model for creating raw file data (with survey_id in body)."""
 
-
 class RawFileUpdate(RawFileBase):
     """Model for updating raw file data.
 
-    Attributes:
-    """
-
-
-class RawFile(RawFileBase):
-    """Model for raw file data with database fields.
-
     Attributes:
         raw_file_id: Unique identifier for the source.
         state: Upload state (uploading, ready, error).
@@ -70,12 +55,18 @@ class RawFile(RawFileBase):
         meta_data: meta data for the uri
         upload_id: S3 multipart upload ID (present while uploading, cleared when complete).
     """
-
     raw_file_id: UUID
     state: RawFileState = RawFileState.UPLOADING
     uri: str | None = None
     meta_data: dict
     upload_id: str | None = None
+
+class RawFile(RawFileUpdate):
+    """Model for raw file data with database fields.
+
+    Attributes:
+    """
+
     created_date: datetime
     updated_date: datetime
     updated_by: str
@@ -88,3 +79,17 @@ class RawFileWithUpload(RawFile):
 
     Overrides optional fields from RawFile to be required for upload responses.
     """
+
+
+class RawFileFilter(BaseModel):
+    """Model for filtering raw files.
+
+    Attributes:
+        survey_id: Survey ID filter (required).
+        state: Optional state filter (uploading, ready, error).
+        raw_configuration_id: Optional raw file configuration ID filter.
+    """
+
+    survey_id: UUID
+    state: RawFileState | None = None
+    raw_configuration_id: UUID | None = None

clarity_api_sdk_python-0.3.20/src/cti/model/raw_file_state.py

@@ -0,0 +1,12 @@
+"""Raw file state"""
+
+from enum import Enum
+
+class RawFileState(str, Enum):
+    """Status of a raw file upload."""
+
+    UPLOADING = "uploading"
+    READY = "ready"
+    ERROR_UPLOAD = "error_upload"
+    ERROR_INGEST = "error_ingest"
+    INGEST_COMPLETE = "ingest_complete"