clarity-api-sdk-python 0.2.12__tar.gz → 0.3.14__tar.gz

{clarity_api_sdk_python-0.2.12 → clarity_api_sdk_python-0.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.2.12
+Version: 0.3.14
 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
@@ -14,7 +14,19 @@ Requires-Dist: brotli
 Requires-Dist: h2
 Requires-Dist: httpx_auth>=0.23.1
 Requires-Dist: httpx-retries>=0.4.5
+Requires-Dist: pydantic==2.12.3
 Requires-Dist: structlog
+Provides-Extra: dev
+Requires-Dist: black==25.9.0; extra == "dev"
+Requires-Dist: build==1.3.0; extra == "dev"
+Requires-Dist: mypy==1.18.2; extra == "dev"
+Requires-Dist: pre-commit==4.3.0; extra == "dev"
+Requires-Dist: pylint==3.3.8; extra == "dev"
+Requires-Dist: pytest==8.4.2; extra == "dev"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev"
+Requires-Dist: pytest-md==0.2.0; extra == "dev"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev"
+Requires-Dist: twine==6.2.0; extra == "dev"
 Provides-Extra: brotli
 Requires-Dist: httpx[brotli]>=0.28.1; extra == "brotli"
 Provides-Extra: http2
@@ -78,6 +90,10 @@ logger_b.info("This info message from logger_b should NOT be visible.")
 logger_b.warning("This is warning message from logger_b")
 ```
 
+## Model
+
+Pydantic models.
+
 ## API
 
 ### Singleton async client

{clarity_api_sdk_python-0.2.12 → clarity_api_sdk_python-0.3.14}/README.md

@@ -56,6 +56,10 @@ logger_b.info("This info message from logger_b should NOT be visible.")
 logger_b.warning("This is warning message from logger_b")
 ```
 
+## Model
+
+Pydantic models.
+
 ## API
 
 ### Singleton async client

{clarity_api_sdk_python-0.2.12 → clarity_api_sdk_python-0.3.14}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clarity-api-sdk-python"
-version = "0.2.12"
+version = "0.3.14"
 authors = [
   { name="Chesapeake Technology Inc.", email="support@chesapeaketech.com" },
 ]
@@ -23,10 +23,23 @@ dependencies = [
     "h2",
     "httpx_auth>=0.23.1",
     "httpx-retries>=0.4.5",
+    "pydantic==2.12.3",
     "structlog",
 ]
 
 [project.optional-dependencies]
+dev = [
+    "black==25.9.0",
+    "build==1.3.0",
+    "mypy==1.18.2",
+    "pre-commit==4.3.0",
+    "pylint==3.3.8",
+    "pytest==8.4.2",
+    "pytest-asyncio==1.3.0",
+    "pytest-md==0.2.0",
+    "pytest-mock==3.15.1",
+    "twine==6.2.0"
+]
 brotli = ["httpx[brotli]>=0.28.1"]
 http2 = ["httpx[http2]>=0.28.1"]
 
@@ -35,3 +48,6 @@ http2 = ["httpx[http2]>=0.28.1"]
 
 [tool.setuptools.packages.find]
 where = ["src"]
+
+[tool.pylint.main]
+max-line-length = 150

{clarity_api_sdk_python-0.2.12 → clarity_api_sdk_python-0.3.14}/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.2.12
+Version: 0.3.14
 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
@@ -14,7 +14,19 @@ Requires-Dist: brotli
 Requires-Dist: h2
 Requires-Dist: httpx_auth>=0.23.1
 Requires-Dist: httpx-retries>=0.4.5
+Requires-Dist: pydantic==2.12.3
 Requires-Dist: structlog
+Provides-Extra: dev
+Requires-Dist: black==25.9.0; extra == "dev"
+Requires-Dist: build==1.3.0; extra == "dev"
+Requires-Dist: mypy==1.18.2; extra == "dev"
+Requires-Dist: pre-commit==4.3.0; extra == "dev"
+Requires-Dist: pylint==3.3.8; extra == "dev"
+Requires-Dist: pytest==8.4.2; extra == "dev"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev"
+Requires-Dist: pytest-md==0.2.0; extra == "dev"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev"
+Requires-Dist: twine==6.2.0; extra == "dev"
 Provides-Extra: brotli
 Requires-Dist: httpx[brotli]>=0.28.1; extra == "brotli"
 Provides-Extra: http2
@@ -78,6 +90,10 @@ logger_b.info("This info message from logger_b should NOT be visible.")
 logger_b.warning("This is warning message from logger_b")
 ```
 
+## Model
+
+Pydantic models.
+
 ## API
 
 ### Singleton async client

clarity_api_sdk_python-0.3.14/src/clarity_api_sdk_python.egg-info/SOURCES.txt

@@ -0,0 +1,52 @@
+README.md
+pyproject.toml
+src/clarity_api_sdk_python.egg-info/PKG-INFO
+src/clarity_api_sdk_python.egg-info/SOURCES.txt
+src/clarity_api_sdk_python.egg-info/dependency_links.txt
+src/clarity_api_sdk_python.egg-info/requires.txt
+src/clarity_api_sdk_python.egg-info/top_level.txt
+src/cti/__init__.py
+src/cti/main.py
+src/cti/main_api.py
+src/cti/api/__init__.py
+src/cti/api/async_client.py
+src/cti/api/client.py
+src/cti/api/session.py
+src/cti/logger/__init__.py
+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/depth_source.py
+src/cti/model/device.py
+src/cti/model/device_type.py
+src/cti/model/final_product.py
+src/cti/model/hierarchy.py
+src/cti/model/layback_algorithm.py
+src/cti/model/layback_source.py
+src/cti/model/layback_type.py
+src/cti/model/organization.py
+src/cti/model/platform.py
+src/cti/model/platform_type.py
+src/cti/model/position_source.py
+src/cti/model/processed_altitude.py
+src/cti/model/processed_attitude.py
+src/cti/model/processed_depth.py
+src/cti/model/processed_layback.py
+src/cti/model/processed_position.py
+src/cti/model/processed_sidescan_ping.py
+src/cti/model/processing_log.py
+src/cti/model/project.py
+src/cti/model/projection_option.py
+src/cti/model/raw_altitude.py
+src/cti/model/raw_attitude.py
+src/cti/model/raw_depth.py
+src/cti/model/raw_layback.py
+src/cti/model/raw_position.py
+src/cti/model/raw_sidescan_ping.py
+src/cti/model/s3.py
+src/cti/model/sidescan_ping_source.py
+src/cti/model/source.py
+src/cti/model/survey.py
+src/cti/model/target.py
+src/cti/model/tow_system.py

clarity_api_sdk_python-0.3.14/src/clarity_api_sdk_python.egg-info/requires.txt

@@ -0,0 +1,25 @@
+httpx>=0.28.1
+brotli
+h2
+httpx_auth>=0.23.1
+httpx-retries>=0.4.5
+pydantic==2.12.3
+structlog
+
+[brotli]
+httpx[brotli]>=0.28.1
+
+[dev]
+black==25.9.0
+build==1.3.0
+mypy==1.18.2
+pre-commit==4.3.0
+pylint==3.3.8
+pytest==8.4.2
+pytest-asyncio==1.3.0
+pytest-md==0.2.0
+pytest-mock==3.15.1
+twine==6.2.0
+
+[http2]
+httpx[http2]>=0.28.1

{clarity_api_sdk_python-0.2.12 → clarity_api_sdk_python-0.3.14}/src/cti/api/session.py

@@ -19,12 +19,11 @@ Example:
         asyncio.run(main())
 
     # In other modules
-    from cti.api.session import async_client
+    from cti.api.session import get_async_client
 
     async def fetch_data():
-        if async_client:
-            response = await async_client.get(...)
-            return response.json()
+        response = await get_async_client().get(...)
+        return response.json()
 """
 
 # pylint: disable=global-statement, unnecessary-dunder-call
@@ -32,7 +31,7 @@ Example:
 from cti.api.async_client import ClarityApiAsyncClient
 
 # The singleton instance, initially None.
-async_client: ClarityApiAsyncClient | None
+async_client: ClarityApiAsyncClient | None = None
 
 
 async def initialize_async_client() -> None:
@@ -46,6 +45,21 @@ async def initialize_async_client() -> None:
         async_client = ClarityApiAsyncClient()
         await async_client.__aenter__()
 
+def get_async_client() -> ClarityApiAsyncClient:
+    """Returns the shared ClarityApiAsyncClient instance.
+
+    If the client is not initialized, this function initializes it first.
+
+    Returns:
+        ClarityApiAsyncClient: The shared ClarityApiAsyncClient instance.
+
+    Raises:
+        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.")
+    return async_client
+
 
 async def close_async_client() -> None:
     """Closes the shared ClarityApiAsyncClient instance.

clarity_api_sdk_python-0.3.14/src/cti/main_api.py

@@ -0,0 +1,19 @@
+"""Example"""
+
+import asyncio
+
+from cti.api.session import get_async_client, close_async_client, initialize_async_client
+
+async def main():
+    """Example of using the Clarity API asynchronously
+    """
+    try:
+        await initialize_async_client()
+        client = get_async_client()
+        response = await client.get(url="/api/v1/status")
+        print(response.json())
+    finally:
+        await close_async_client()
+
+if __name__ == "__main__":
+    asyncio.run(main())

clarity_api_sdk_python-0.3.14/src/cti/model/altitude_source.py

@@ -0,0 +1,66 @@
+"""Pydantic models for altitude source data."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+
+class AltitudeSourceBase(BaseModel):
+    """Base model for altitude source data.
+
+    Attributes:
+        input_timezone: Input timezone string.
+        start_time: Start timestamp.
+        end_time: End timestamp.
+        channels: Number of channels.
+    """
+
+    input_timezone: str
+    start_time: datetime
+    end_time: datetime
+    channels: int
+
+
+class AltitudeSourceCreate(AltitudeSourceBase):
+    """Model for creating altitude source data.
+
+    Attributes:
+        device_id: Foreign key reference to Device.
+        source_id: Foreign key reference to Source.
+    """
+
+    device_id: UUID
+    source_id: UUID
+
+
+class AltitudeSourceUpdate(BaseModel):
+    """Model for updating altitude source data.
+
+    Attributes:
+        input_timezone: Input timezone string.
+        start_time: Start timestamp.
+        end_time: End timestamp.
+        channels: Number of channels.
+    """
+
+    input_timezone: str | None = None
+    start_time: datetime | None = None
+    end_time: datetime | None = None
+    channels: int | None = None
+
+
+class AltitudeSource(AltitudeSourceBase):
+    """Model for altitude source data with database fields.
+
+    Attributes:
+        altitude_source_id: Unique identifier for the altitude source.
+        device_id: Foreign key reference to Device.
+        source_id: Foreign key reference to Source.
+    """
+
+    altitude_source_id: UUID
+    device_id: UUID
+    source_id: UUID
+
+    model_config = ConfigDict(from_attributes=True)

clarity_api_sdk_python-0.3.14/src/cti/model/attitude_source.py

@@ -0,0 +1,94 @@
+"""Pydantic models for attitude source data."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+
+class AttitudeSourceBase(BaseModel):
+    """Base model for attitude source data.
+
+    Attributes:
+        input_timezone: Input timezone string.
+        channels: Number of channels.
+        start_time: Start timestamp.
+        end_time: End timestamp.
+        sample_rate: Sample rate in Hz.
+        projection_option: Foreign key reference to ProjectionOption.
+        apply_pitch: Whether to apply pitch correction.
+        offset_roll: Roll offset value.
+        offset_pitch: Pitch offset value.
+        offset_heading: Heading offset value.
+        offset_time: Time offset value.
+    """
+
+    input_timezone: str
+    channels: int
+    start_time: datetime
+    end_time: datetime
+    sample_rate: float | None = None
+    projection_option: UUID
+    apply_pitch: bool | None = None
+    offset_roll: float | None = None
+    offset_pitch: float | None = None
+    offset_heading: float | None = None
+    offset_time: float | None = None
+
+
+class AttitudeSourceCreate(AttitudeSourceBase):
+    """Model for creating attitude source data.
+
+    Attributes:
+        device_id: Foreign key reference to Device.
+        source_id: Foreign key reference to Source.
+    """
+
+    device_id: UUID
+    source_id: UUID
+
+
+class AttitudeSourceUpdate(BaseModel):
+    """Model for updating attitude source data.
+
+    Attributes:
+        input_timezone: Input timezone string.
+        channels: Number of channels.
+        start_time: Start timestamp.
+        end_time: End timestamp.
+        sample_rate: Sample rate in Hz.
+        projection_option: Foreign key reference to ProjectionOption.
+        apply_pitch: Whether to apply pitch correction.
+        offset_roll: Roll offset value.
+        offset_pitch: Pitch offset value.
+        offset_heading: Heading offset value.
+        offset_time: Time offset value.
+    """
+
+    input_timezone: str | None = None
+    channels: int | None = None
+    start_time: datetime | None = None
+    end_time: datetime | None = None
+    sample_rate: float | None = None
+    projection_option: UUID | None = None
+    apply_pitch: bool | None = None
+    offset_roll: float | None = None
+    offset_pitch: float | None = None
+    offset_heading: float | None = None
+    offset_time: float | None = None
+
+
+class AttitudeSource(AttitudeSourceBase):
+    """Model for attitude source data with database fields.
+
+    Attributes:
+        attitude_source_id: Unique identifier for the attitude source.
+        device_id: Foreign key reference to Device.
+        source_id: Foreign key reference to Source.
+    """
+
+    attitude_source_id: UUID
+    device_id: UUID
+    source_id: UUID
+
+    model_config = ConfigDict(from_attributes=True)

clarity_api_sdk_python-0.3.14/src/cti/model/depth_source.py

@@ -0,0 +1,86 @@
+"""Pydantic models for depth source data."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+
+class DepthSourceBase(BaseModel):
+    """Base model for depth source data.
+
+    Attributes:
+        input_timezone: Input timezone string.
+        channels: Number of channels.
+        start_time: Start timestamp.
+        end_time: End timestamp.
+        records: Number of records.
+        sample_rate: Sample rate in Hz.
+        smoothing: Smoothing parameter.
+        offset_z: Z-axis offset.
+        offset_time: Time offset.
+    """
+
+    input_timezone: str
+    channels: int
+    start_time: datetime
+    end_time: datetime
+    records: int | None = None
+    sample_rate: float | None = None
+    smoothing: float | None = None
+    offset_z: float | None = None
+    offset_time: float | None = None
+
+
+class DepthSourceCreate(DepthSourceBase):
+    """Model for creating depth source data.
+
+    Attributes:
+        device_id: Foreign key reference to Device.
+        source_id: Foreign key reference to Source.
+    """
+
+    device_id: UUID
+    source_id: UUID
+
+
+class DepthSourceUpdate(BaseModel):
+    """Model for updating depth source data.
+
+    Attributes:
+        input_timezone: Input timezone string.
+        channels: Number of channels.
+        start_time: Start timestamp.
+        end_time: End timestamp.
+        records: Number of records.
+        sample_rate: Sample rate in Hz.
+        smoothing: Smoothing parameter.
+        offset_z: Z-axis offset.
+        offset_time: Time offset.
+    """
+
+    input_timezone: str | None = None
+    channels: int | None = None
+    start_time: datetime | None = None
+    end_time: datetime | None = None
+    records: int | None = None
+    sample_rate: float | None = None
+    smoothing: float | None = None
+    offset_z: float | None = None
+    offset_time: float | None = None
+
+
+class DepthSource(DepthSourceBase):
+    """Model for depth source data with database fields.
+
+    Attributes:
+        depth_source_id: Unique identifier for the depth source.
+        device_id: Foreign key reference to Device.
+        source_id: Foreign key reference to Source.
+    """
+
+    depth_source_id: UUID
+    device_id: UUID
+    source_id: UUID
+
+    model_config = ConfigDict(from_attributes=True)

clarity_api_sdk_python-0.3.14/src/cti/model/device.py

@@ -0,0 +1,92 @@
+"""Pydantic models for device data."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+
+class DeviceBase(BaseModel):
+    """Base model for device data.
+
+    Attributes:
+        name: Device name.
+        channels: Number of channels.
+        offset_x: X-axis offset.
+        offset_y: Y-axis offset.
+        offset_z: Z-axis offset.
+        offset_heading: Heading offset.
+        offset_pitch: Pitch offset.
+        offset_roll: Roll offset.
+        latency: Device latency.
+        is_towed: Whether the device is towed.
+    """
+
+    name: str
+    channels: int
+    offset_x: float
+    offset_y: float
+    offset_z: float
+    offset_heading: float
+    offset_pitch: float
+    offset_roll: float
+    latency: float
+    is_towed: bool
+
+
+class DeviceCreate(DeviceBase):
+    """Model for creating device data.
+
+    Attributes:
+        platform_id: Foreign key reference to Platform.
+        device_type_id: Foreign key reference to DeviceType.
+    """
+
+    platform_id: UUID
+    device_type_id: UUID
+
+
+class DeviceUpdate(DeviceBase):
+    """Model for updating device data.
+
+    Attributes:
+        name: Device name.
+        channels: Number of channels.
+        offset_x: X-axis offset.
+        offset_y: Y-axis offset.
+        offset_z: Z-axis offset.
+        offset_heading: Heading offset.
+        offset_pitch: Pitch offset.
+        offset_roll: Roll offset.
+        latency: Device latency.
+        is_towed: Whether the device is towed.
+        updated_by: User who updated the device.
+    """
+
+
+class Device(DeviceBase):
+    """Model for device data with database fields.
+
+    Attributes:
+        device_id: Unique identifier for the device.
+        platform_id: Foreign key reference to Platform.
+        device_type_id: Foreign key reference to DeviceType.
+        updated_by: User who last updated the device.
+        updated_date: Date when the device was last updated.
+        created_date: Date when the device was created.
+    """
+
+    device_id: UUID
+    platform_id: UUID
+    device_type_id: UUID
+    updated_by: str
+    updated_date: datetime
+    created_date: datetime
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class Devices(BaseModel):
+    """Model for a collection of devices."""
+
+    devices: list[Device]

clarity_api_sdk_python-0.3.14/src/cti/model/device_type.py

@@ -0,0 +1,60 @@
+"""Pydantic models for device type data."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+
+class DeviceTypeBase(BaseModel):
+    """Base model for device type data.
+
+    Attributes:
+        name: Device type name.
+        description: Device type description.
+    """
+
+    name: str
+    description: str | None = None
+
+
+class DeviceTypeCreate(DeviceTypeBase):
+    """Model for creating device type data.
+
+    Attributes:
+        updated_by: User who created the device type.
+    """
+
+
+class DeviceTypeUpdate(DeviceTypeBase):
+    """Model for updating device type data.
+
+    Attributes:
+        name: Device type name.
+        description: Device type description.
+        updated_by: User who updated the device type.
+    """
+
+
+class DeviceType(DeviceTypeBase):
+    """Model for device type data with database fields.
+
+    Attributes:
+        device_type_id: Unique identifier for the device type.
+        updated_by: User who last updated the device type.
+        updated_date: Date when the device type was last updated.
+        created_date: Date when the device type was created.
+    """
+
+    device_type_id: UUID
+    updated_by: str
+    updated_date: datetime
+    created_date: datetime
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class DeviceTypes(BaseModel):
+    """Model for a collection of device type."""
+
+    device_types: list[DeviceType]