clarity-api-sdk-python 0.3.19__tar.gz → 0.3.23__tar.gz

{clarity_api_sdk_python-0.3.19 → clarity_api_sdk_python-0.3.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.19
+Version: 0.3.23
 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

{clarity_api_sdk_python-0.3.19 → clarity_api_sdk_python-0.3.23}/pyproject.toml

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

{clarity_api_sdk_python-0.3.19 → clarity_api_sdk_python-0.3.23}/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.19
+Version: 0.3.23
 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

{clarity_api_sdk_python-0.3.19 → clarity_api_sdk_python-0.3.23}/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,8 @@ 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_device_mapping.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.19 → clarity_api_sdk_python-0.3.23}/src/cti/api/session.py

@@ -45,6 +45,7 @@ async def initialize_async_client() -> None:
         async_client = ClarityApiAsyncClient()
         await async_client.__aenter__()
 
+
 def get_async_client() -> ClarityApiAsyncClient:
     """Returns the shared ClarityApiAsyncClient instance.
 
@@ -57,7 +58,9 @@ def get_async_client() -> ClarityApiAsyncClient:
         ValueError: If initialize_async_client() has not been called first.
     """
     if async_client is None:
-        raise ValueError("initialize_async_client() must be called first to initialize client.")
+        raise ValueError(
+            "initialize_async_client() must be called first to initialize client."
+        )
     return async_client
 
 

{clarity_api_sdk_python-0.3.19 → clarity_api_sdk_python-0.3.23}/src/cti/main_api.py

@@ -2,11 +2,15 @@
 
 import asyncio
 
-from cti.api.session import get_async_client, close_async_client, initialize_async_client
+from cti.api.session import (
+    get_async_client,
+    close_async_client,
+    initialize_async_client,
+)
+
 
 async def main():
-    """Example of using the Clarity API asynchronously
-    """
+    """Example of using the Clarity API asynchronously"""
     try:
         await initialize_async_client()
         client = get_async_client()
@@ -15,5 +19,6 @@ async def main():
     finally:
         await close_async_client()
 
+
 if __name__ == "__main__":
     asyncio.run(main())

clarity_api_sdk_python-0.3.23/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.19 → clarity_api_sdk_python-0.3.23}/src/cti/model/device.py

@@ -3,7 +3,7 @@
 from datetime import datetime
 from uuid import UUID
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class DeviceBase(BaseModel):
@@ -11,7 +11,7 @@ class DeviceBase(BaseModel):
 
     Attributes:
         name: Device name.
-        channels: Number of channels.
+        channel: channel id.
         offset_x: X-axis offset.
         offset_y: Y-axis offset.
         offset_z: Z-axis offset.
@@ -23,7 +23,7 @@ class DeviceBase(BaseModel):
     """
 
     name: str
-    channels: int
+    channel: int = Field(ge=0)
     offset_x: float
     offset_y: float
     offset_z: float
@@ -51,7 +51,7 @@ class DeviceUpdate(DeviceBase):
 
     Attributes:
         name: Device name.
-        channels: Number of channels.
+        channel: channel id.
         offset_x: X-axis offset.
         offset_y: Y-axis offset.
         offset_z: Z-axis offset.

{clarity_api_sdk_python-0.3.19 → clarity_api_sdk_python-0.3.23}/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 .raw_file_state import RawFileState
 
 
 class RawFileBase(BaseModel):
@@ -56,13 +49,6 @@ class RawFileCreate(RawFileBase):
 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).
@@ -76,6 +62,14 @@ class RawFile(RawFileBase):
     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 +82,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.23/src/cti/model/raw_file_device_mapping.py

@@ -0,0 +1,69 @@
+"""Pydantic model for mapping a raw file to a device."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class RawFileDeviceMappingBase(BaseModel):
+    """Base model for raw file device mapping.
+
+    Attributes:
+        raw_file_id: Foreign key reference to RawFile.
+        device_id: Foreign key reference to Device.
+        source_stream_identifier: Identifier for the source stream.
+        input_srid: Spatial reference ID for the input data.
+        input_timezone: Timezone for the input data.
+    """
+
+    raw_file_id: UUID
+    device_id: UUID
+    source_stream_identifier: str
+    input_srid: int = Field(ge=2000, le=900913)
+    input_timezone: str = Field(pattern=r"^UTM([+-]\d+)?$")
+
+
+class RawFileDeviceMappingCreate(RawFileDeviceMappingBase):
+    """Model for creating raw file device mapping data."""
+
+
+class RawFileDeviceMappingUpdate(RawFileDeviceMappingBase):
+    """Model for updating raw file device mapping data.
+
+    Attributes:
+        mapping_id: Unique identifier for the mapping.
+        created_date: Date and time when the mapping was created.
+        updated_date: Date and time when the mapping was last updated.
+        updated_by: User who last updated the mapping.
+
+    """
+
+
+class RawFileDeviceMapping(RawFileDeviceMappingUpdate):
+    """Model for raw file device mapping data with database fields.
+
+    Attributes:
+        created_date: Date and time when the mapping was created.
+        updated_date: Date and time when the mapping was last updated.
+        updated_by: User who last updated the mapping.
+    """
+
+    mapping_id: UUID
+    created_date: datetime
+    updated_date: datetime
+    updated_by: str
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class RawFileDeviceMappingFilter(BaseModel):
+    """Model for filtering raw file device mappings.
+
+    Attributes:
+        raw_file_id: Raw file ID filter (required).
+        device_id: Device ID filter (required).
+    """
+
+    raw_file_id: UUID
+    device_id: UUID

clarity_api_sdk_python-0.3.23/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"