cirro-api-client 0.3.0__tar.gz → 0.3.2__tar.gz

{cirro_api_client-0.3.0 → cirro_api_client-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cirro_api_client
-Version: 0.3.0
+Version: 0.3.2
 Summary: A client library for accessing Cirro
 License: MIT
 Keywords: Cirro

{cirro_api_client-0.3.0 → cirro_api_client-0.3.2}/cirro_api_client/v1/models/__init__.py

@@ -13,6 +13,8 @@ from .agent_status import AgentStatus
 from .agent_tags import AgentTags
 from .allowed_data_type import AllowedDataType
 from .approve_project_access_request import ApproveProjectAccessRequest
+from .artifact import Artifact
+from .artifact_type import ArtifactType
 from .audit_event import AuditEvent
 from .audit_event_changes import AuditEventChanges
 from .audit_event_event_detail import AuditEventEventDetail
@@ -169,6 +171,8 @@ __all__ = (
     "AgentTags",
     "AllowedDataType",
     "ApproveProjectAccessRequest",
+    "Artifact",
+    "ArtifactType",
     "AuditEvent",
     "AuditEventChanges",
     "AuditEventEventDetail",

cirro_api_client-0.3.2/cirro_api_client/v1/models/artifact.py

@@ -0,0 +1,57 @@
+from typing import Any, Dict, List, Type, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.artifact_type import ArtifactType
+
+T = TypeVar("T", bound="Artifact")
+
+
+@_attrs_define
+class Artifact:
+    """A secondary file or resource associated with a dataset
+
+    Attributes:
+        type (ArtifactType):
+        path (str):
+    """
+
+    type: ArtifactType
+    path: str
+    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        type = self.type.value
+
+        path = self.path
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "type": type,
+                "path": path,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        type = ArtifactType(d.pop("type"))
+
+        path = d.pop("path")
+
+        artifact = cls(
+            type=type,
+            path=path,
+        )
+
+        artifact.additional_properties = d
+        return artifact
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())

cirro_api_client-0.3.2/cirro_api_client/v1/models/artifact_type.py

@@ -0,0 +1,39 @@
+from enum import Enum
+
+
+class ArtifactType(str, Enum):
+    FILES = "FILES"
+    """ Files used in the workflow """
+    INGEST_MANIFEST = "INGEST_MANIFEST"
+    """ Files expected to upload """
+    METADATA = "METADATA"
+    """ Snapshot of metadata at the time of execution """
+    SAMPLE_SHEET = "SAMPLE_SHEET"
+    """ Samples used in the workflow """
+    WORKFLOW_COMPUTE_CONFIG = "WORKFLOW_COMPUTE_CONFIG"
+    """ Compute overrides used in the workflow """
+    WORKFLOW_DAG = "WORKFLOW_DAG"
+    """ Direct acyclic graph of workflow execution """
+    WORKFLOW_DEBUG_LOGS = "WORKFLOW_DEBUG_LOGS"
+    """ Debug logs from workflow engine """
+    WORKFLOW_LOGS = "WORKFLOW_LOGS"
+    """ Logs from workflow engine """
+    WORKFLOW_OPTIONS = "WORKFLOW_OPTIONS"
+    """ Options used in the workflow """
+    WORKFLOW_PARAMETERS = "WORKFLOW_PARAMETERS"
+    """ Parameters used in the workflow """
+    WORKFLOW_REPORT = "WORKFLOW_REPORT"
+    """ Execution report from workflow engine """
+    WORKFLOW_TIMELINE = "WORKFLOW_TIMELINE"
+    """ Timeline of workflow execution """
+    WORKFLOW_TRACE = "WORKFLOW_TRACE"
+    """ Trace of workflow execution """
+    UNKNOWN = "UNKNOWN"
+    """ This is a fallback value for when the value is not known, do not use this value when making requests """
+
+    def __str__(self) -> str:
+        return str(self.value)
+
+    @classmethod
+    def _missing_(cls, number):
+        return cls(cls.UNKNOWN)

{cirro_api_client-0.3.0 → cirro_api_client-0.3.2}/cirro_api_client/v1/models/create_notebook_instance_request.py

@@ -16,6 +16,8 @@ class CreateNotebookInstanceRequest:
         instance_type (str): AWS EC2 Instance Type (see list of available options) Example: ml.t3.medium.
         accelerator_types (List[str]):
         volume_size_gb (int):
+        git_repositories (Union[List[str], None, Unset]): List of public git repositories to clone into the notebook
+            instance.
         is_shared_with_project (Union[Unset, bool]): Whether the notebook is shared with the project Default: False.
     """
 
@@ -23,6 +25,7 @@ class CreateNotebookInstanceRequest:
     instance_type: str
     accelerator_types: List[str]
     volume_size_gb: int
+    git_repositories: Union[List[str], None, Unset] = UNSET
     is_shared_with_project: Union[Unset, bool] = False
     additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
 
@@ -35,6 +38,15 @@ class CreateNotebookInstanceRequest:
 
         volume_size_gb = self.volume_size_gb
 
+        git_repositories: Union[List[str], None, Unset]
+        if isinstance(self.git_repositories, Unset):
+            git_repositories = UNSET
+        elif isinstance(self.git_repositories, list):
+            git_repositories = self.git_repositories
+
+        else:
+            git_repositories = self.git_repositories
+
         is_shared_with_project = self.is_shared_with_project
 
         field_dict: Dict[str, Any] = {}
@@ -47,6 +59,8 @@ class CreateNotebookInstanceRequest:
                 "volumeSizeGB": volume_size_gb,
             }
         )
+        if git_repositories is not UNSET:
+            field_dict["gitRepositories"] = git_repositories
         if is_shared_with_project is not UNSET:
             field_dict["isSharedWithProject"] = is_shared_with_project
 
@@ -63,6 +77,23 @@ class CreateNotebookInstanceRequest:
 
         volume_size_gb = d.pop("volumeSizeGB")
 
+        def _parse_git_repositories(data: object) -> Union[List[str], None, Unset]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            try:
+                if not isinstance(data, list):
+                    raise TypeError()
+                git_repositories_type_0 = cast(List[str], data)
+
+                return git_repositories_type_0
+            except:  # noqa: E722
+                pass
+            return cast(Union[List[str], None, Unset], data)
+
+        git_repositories = _parse_git_repositories(d.pop("gitRepositories", UNSET))
+
         is_shared_with_project = d.pop("isSharedWithProject", UNSET)
 
         create_notebook_instance_request = cls(
@@ -70,6 +101,7 @@ class CreateNotebookInstanceRequest:
             instance_type=instance_type,
             accelerator_types=accelerator_types,
             volume_size_gb=volume_size_gb,
+            git_repositories=git_repositories,
             is_shared_with_project=is_shared_with_project,
         )
 

{cirro_api_client-0.3.0 → cirro_api_client-0.3.2}/cirro_api_client/v1/models/dataset_assets_manifest.py

@@ -6,6 +6,7 @@ from attrs import field as _attrs_field
 from ..types import UNSET, Unset
 
 if TYPE_CHECKING:
+    from ..models.artifact import Artifact
     from ..models.dataset_viz import DatasetViz
     from ..models.file_entry import FileEntry
     from ..models.table import Table
@@ -23,6 +24,7 @@ class DatasetAssetsManifest:
         total_files (Union[Unset, int]): Total number of files in the dataset, used for pagination
         viz (Union[Unset, List['DatasetViz']]): List of viz to render for the dataset
         tables (Union[Unset, List['Table']]): List of web optimized tables for the dataset
+        artifacts (Union[Unset, List['Artifact']]): Artifacts associated with the dataset
     """
 
     domain: Union[Unset, str] = UNSET
@@ -30,6 +32,7 @@ class DatasetAssetsManifest:
     total_files: Union[Unset, int] = UNSET
     viz: Union[Unset, List["DatasetViz"]] = UNSET
     tables: Union[Unset, List["Table"]] = UNSET
+    artifacts: Union[Unset, List["Artifact"]] = UNSET
     additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
@@ -58,6 +61,13 @@ class DatasetAssetsManifest:
                 tables_item = tables_item_data.to_dict()
                 tables.append(tables_item)
 
+        artifacts: Union[Unset, List[Dict[str, Any]]] = UNSET
+        if not isinstance(self.artifacts, Unset):
+            artifacts = []
+            for artifacts_item_data in self.artifacts:
+                artifacts_item = artifacts_item_data.to_dict()
+                artifacts.append(artifacts_item)
+
         field_dict: Dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update({})
@@ -71,11 +81,14 @@ class DatasetAssetsManifest:
             field_dict["viz"] = viz
         if tables is not UNSET:
             field_dict["tables"] = tables
+        if artifacts is not UNSET:
+            field_dict["artifacts"] = artifacts
 
         return field_dict
 
     @classmethod
     def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.artifact import Artifact
         from ..models.dataset_viz import DatasetViz
         from ..models.file_entry import FileEntry
         from ..models.table import Table
@@ -106,12 +119,20 @@ class DatasetAssetsManifest:
 
             tables.append(tables_item)
 
+        artifacts = []
+        _artifacts = d.pop("artifacts", UNSET)
+        for artifacts_item_data in _artifacts or []:
+            artifacts_item = Artifact.from_dict(artifacts_item_data)
+
+            artifacts.append(artifacts_item)
+
         dataset_assets_manifest = cls(
             domain=domain,
             files=files,
             total_files=total_files,
             viz=viz,
             tables=tables,
+            artifacts=artifacts,
         )
 
         dataset_assets_manifest.additional_properties = d

{cirro_api_client-0.3.0 → cirro_api_client-0.3.2}/cirro_api_client/v1/models/notebook_instance.py

@@ -20,6 +20,7 @@ class NotebookInstance:
         status_message (str):
         instance_type (str):
         accelerator_types (List[str]):
+        git_repositories (List[str]):
         volume_size_gb (int):
         is_shared_with_project (bool):
         created_by (str):
@@ -33,6 +34,7 @@ class NotebookInstance:
     status_message: str
     instance_type: str
     accelerator_types: List[str]
+    git_repositories: List[str]
     volume_size_gb: int
     is_shared_with_project: bool
     created_by: str
@@ -53,6 +55,8 @@ class NotebookInstance:
 
         accelerator_types = self.accelerator_types
 
+        git_repositories = self.git_repositories
+
         volume_size_gb = self.volume_size_gb
 
         is_shared_with_project = self.is_shared_with_project
@@ -73,6 +77,7 @@ class NotebookInstance:
                 "statusMessage": status_message,
                 "instanceType": instance_type,
                 "acceleratorTypes": accelerator_types,
+                "gitRepositories": git_repositories,
                 "volumeSizeGB": volume_size_gb,
                 "isSharedWithProject": is_shared_with_project,
                 "createdBy": created_by,
@@ -98,6 +103,8 @@ class NotebookInstance:
 
         accelerator_types = cast(List[str], d.pop("acceleratorTypes"))
 
+        git_repositories = cast(List[str], d.pop("gitRepositories"))
+
         volume_size_gb = d.pop("volumeSizeGB")
 
         is_shared_with_project = d.pop("isSharedWithProject")
@@ -115,6 +122,7 @@ class NotebookInstance:
             status_message=status_message,
             instance_type=instance_type,
             accelerator_types=accelerator_types,
+            git_repositories=git_repositories,
             volume_size_gb=volume_size_gb,
             is_shared_with_project=is_shared_with_project,
             created_by=created_by,

{cirro_api_client-0.3.0 → cirro_api_client-0.3.2}/cirro_api_client/v1/models/share_type.py

@@ -3,8 +3,11 @@ from enum import Enum
 
 class ShareType(str, Enum):
     AVAILABLE = "AVAILABLE"
+    """ The share is available for subscription """
     PUBLISHER = "PUBLISHER"
+    """ The project owns this share """
     SUBSCRIBER = "SUBSCRIBER"
+    """ The project can view this share """
     UNKNOWN = "UNKNOWN"
     """ This is a fallback value for when the value is not known, do not use this value when making requests """
 

{cirro_api_client-0.3.0 → cirro_api_client-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cirro_api_client"
-version = "0.3.0"
+version = "0.3.2"
 description = "A client library for accessing Cirro"
 authors = ["Cirro <support@cirro.bio>"]
 license = "MIT"