clarity-api-sdk-python 0.3.15__tar.gz → 0.3.17__tar.gz

{clarity_api_sdk_python-0.3.15 → clarity_api_sdk_python-0.3.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.15
+Version: 0.3.17
 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.15 → clarity_api_sdk_python-0.3.17}/pyproject.toml

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

{clarity_api_sdk_python-0.3.15 → clarity_api_sdk_python-0.3.17}/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.15
+Version: 0.3.17
 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.15 → clarity_api_sdk_python-0.3.17}/src/clarity_api_sdk_python.egg-info/SOURCES.txt

@@ -41,6 +41,8 @@ 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_file.py
+src/cti/model/raw_file_configuration.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.15 → clarity_api_sdk_python-0.3.17}/src/cti/model/device_type.py

@@ -12,10 +12,16 @@ class DeviceTypeBase(BaseModel):
     Attributes:
         name: Device type name.
         description: Device type description.
+        enum_name: Enum name. Once set do NOT change. This will be used to define JSOB keys in
+          `raw_file_configuration#configuration` column. For example,
+          `usbl`, `sidescan_sonar`, `altimeter`, etc.
+        can_parent: Indicates if the device type can be a parent device.
     """
 
     name: str
     description: str | None = None
+    enum_name: str
+    can_parent: bool = False
 
 
 class DeviceTypeCreate(DeviceTypeBase):

{clarity_api_sdk_python-0.3.15 → clarity_api_sdk_python-0.3.17}/src/cti/model/hierarchy.py

@@ -6,28 +6,34 @@ from pydantic import BaseModel
 
 
 class Organization(BaseModel):
-    """Pydantic model for organization data."""
+    """Pydantic model for organization hierarchy data."""
 
     organization_id: UUID
     organization_name: str
 
 
 class Project(Organization):
-    """Pydantic model for project data."""
+    """Pydantic model for project hierarchy data."""
 
     project_id: UUID
     project_name: str
 
 
 class Survey(Project):
-    """Pydantic model for survey data."""
+    """Pydantic model for survey hierarchy data."""
 
     survey_id: UUID
     survey_name: str
 
 
 class Source(Survey):
-    """Pydantic model for source data."""
+    """Pydantic model for source hierarchy data."""
 
     source_id: UUID
-    source_file_name: str
+
+
+class RawFile(Survey):
+    """Pydantic model for raw file hierarchy data."""
+
+    raw_file_id: UUID
+    raw_file_file_name: str

clarity_api_sdk_python-0.3.15/src/cti/model/source.py → clarity_api_sdk_python-0.3.17/src/cti/model/raw_file.py

@@ -1,4 +1,4 @@
-"""Pydantic models for source data."""
+"""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
@@ -7,24 +7,26 @@ from uuid import UUID
 from pydantic import BaseModel, ConfigDict, field_validator
 
 
-class SourceStatus(str, Enum):
-    """Status of a source file upload."""
+class RawFileState(str, Enum):
+    """State of a raw file upload."""
 
     UPLOADING = "uploading"
     READY = "ready"
     ERROR = "error"
 
 
-class SourceBase(BaseModel):
-    """Base model for source data.
+class RawFileBase(BaseModel):
+    """Base model for raw file data.
 
     Attributes:
         survey_id: Foreign key reference to Survey.
-        file_name: Name of the external source file.
-        file_size: Size of the external source file in bytes.
+        raw_file_configuration_id: Foreign key reference to RawFileConfiguration.
+        file_name: Name of the external raw file.
+        file_size: Size of the external raw file in bytes.
     """
 
     survey_id: UUID
+    raw_file_configuration_id: UUID
     file_name: str
     file_size: int
 
@@ -34,7 +36,7 @@ class SourceBase(BaseModel):
         """Validate that file_name has a '.xtf' or '.jsf' extension.
 
         Args:
-            value: Name of the external source file.
+            value: Name of the external raw file.
 
         Returns:
             The validated file_name.
@@ -47,30 +49,30 @@ class SourceBase(BaseModel):
         return value
 
 
-class SourceCreate(SourceBase):
-    """Model for creating source data (with survey_id in body)."""
+class RawFileCreate(RawFileBase):
+    """Model for creating raw file data (with survey_id in body)."""
 
 
-class SourceUpdate(SourceBase):
-    """Model for updating source data.
+class RawFileUpdate(RawFileBase):
+    """Model for updating raw file data.
 
     Attributes:
     """
 
 
-class Source(SourceBase):
-    """Model for source data with database fields.
+class RawFile(RawFileBase):
+    """Model for raw file data with database fields.
 
     Attributes:
-        source_id: Unique identifier for the source.
-        status: Upload status (uploading, ready, error).
-        uri: uri for source, will allow AWS S3, Google Cloud Storage, NFS, URL, or Azure Blob URI (set after upload initiated).
+        raw_file_id: Unique identifier for the source.
+        state: Upload state (uploading, ready, error).
+        uri: uri for raw file, will allow AWS S3, Google Cloud Storage, NFS, URL, or Azure Blob URI (set after upload initiated).
         meta_data: meta data for the uri
         upload_id: S3 multipart upload ID (present while uploading, cleared when complete).
     """
 
-    source_id: UUID
-    status: SourceStatus = SourceStatus.UPLOADING
+    raw_file_id: UUID
+    state: RawFileState = RawFileState.UPLOADING
     uri: str | None = None
     meta_data: dict
     upload_id: str | None = None
@@ -81,8 +83,8 @@ class Source(SourceBase):
     model_config = ConfigDict(from_attributes=True)
 
 
-class SourceWithUpload(Source):
-    """Source response including upload information.
+class RawFileWithUpload(RawFile):
+    """RawFile response including upload information.
 
-    Overrides optional fields from Source to be required for upload responses.
+    Overrides optional fields from RawFile to be required for upload responses.
     """

clarity_api_sdk_python-0.3.17/src/cti/model/raw_file_configuration.py

@@ -0,0 +1,47 @@
+"""Pydantic models for raw file. This is the data that has been uploaded but not ingested into the database."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+
+class RawFileConfigurationBase(BaseModel):
+    """Base model for raw file configuration.
+
+    Attributes:
+        survey_id: Foreign key reference to Survey.
+        name: Name of the raw file configuration.
+        configuration: Configuration settings for the raw file.
+    """
+
+    survey_id: UUID
+    name: str
+    configuration: dict
+
+
+class RawFileConfigurationCreate(RawFileConfigurationBase):
+    """Model for creating raw file configuration (with survey_id in body)."""
+
+
+class RawFileConfigurationUpdate(RawFileConfigurationBase):
+    """Model for updating raw file configuration.
+
+    Attributes:
+    """
+
+
+class RawFileConfiguration(RawFileConfigurationBase):
+    """Model for raw file configuration data with database fields.
+
+    Attributes:
+        survey_id: Unique identifier for the survey.
+        raw_file_configuration_id: Unique identifier for the raw file configuration.
+    """
+
+    raw_file_configuration_id: UUID
+    created_date: datetime
+    updated_date: datetime
+    updated_by: str
+
+    model_config = ConfigDict(from_attributes=True)

clarity_api_sdk_python-0.3.17/src/cti/model/source.py

@@ -0,0 +1,49 @@
+"""Pydantic models for source data."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+
+class SourceBase(BaseModel):
+    """Base model for source data.
+
+    Attributes:
+        survey_id: Foreign key reference to Survey.
+    """
+
+    survey_id: UUID
+
+
+class SourceCreate(SourceBase):
+    """Model for creating source data (with survey_id in body)."""
+
+
+class SourceUpdate(SourceBase):
+    """Model for updating source data.
+
+    Attributes:
+    """
+
+
+class Source(SourceBase):
+    """Model for source data with database fields.
+
+    Attributes:
+        source_id: Unique identifier for the source.
+    """
+
+    source_id: UUID
+    created_date: datetime
+    updated_date: datetime
+    updated_by: str
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class SourceWithUpload(Source):
+    """Source response including upload information.
+
+    Overrides optional fields from Source to be required for upload responses.
+    """