codeocean 0.1.2__tar.gz → 0.1.4__tar.gz

codeocean-0.1.4/CHANGELOG.md

@@ -0,0 +1,21 @@
+CHANGELOG
+=========
+
+## 0.1.4 (2024-08-02)
+
+- Add support for Python >= 3.9 
+
+## 0.1.3 (2024-07-09)
+
+- [#8](https://github.com/codeocean/codeocean-sdk-python/pull/8) fix: add TCPKeepAlive to client requests
+- [#6](https://github.com/codeocean/codeocean-sdk-python/pull/6) feat: Add ResultsInfo to DataAssetParams
+- [#5](https://github.com/codeocean/codeocean-sdk-python/pull/5) fix: SourceBucket optional fields
+- [#3](https://github.com/codeocean/codeocean-sdk-python/pull/3) feat: Add external field to SourceBucket
+
+## 0.1.2 (2024-03-20)
+
+- Fix minimum required Pyhton version (3.11)
+
+## 0.1.0 (2024-03-18)
+
+Initial version

{codeocean-0.1.2 → codeocean-0.1.4}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) [2024] [Code Ocean]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) [2024] [Code Ocean]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{codeocean-0.1.2 → codeocean-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: codeocean
-Version: 0.1.2
+Version: 0.1.4
 Summary: Code Ocean Python SDK
 Project-URL: Homepage, https://github.com/codeocean/codeocean-sdk-python
 Project-URL: Issues, https://github.com/codeocean/codeocean-sdk-python/issues
@@ -11,15 +11,15 @@ License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.11
+Requires-Python: >=3.9
+Requires-Dist: backports-strenum>=1.3.1; python_version < '3.11'
 Requires-Dist: dataclasses
 Requires-Dist: dataclasses-json
 Requires-Dist: requests
 Requires-Dist: requests-toolbelt
 Provides-Extra: dev
 Requires-Dist: flake8; extra == 'dev'
-Provides-Extra: publish
-Requires-Dist: hatch; extra == 'publish'
+Requires-Dist: hatch; extra == 'dev'
 Description-Content-Type: text/markdown
 
 ![Code Ocean Logo](https://raw.githubusercontent.com/codeocean/branding/main/logo/CO_logo_135x72.png)

{codeocean-0.1.2 → codeocean-0.1.4}/pyproject.toml

@@ -4,13 +4,13 @@ build-backend = "hatchling.build"
 
 [project]
 name = "codeocean"
-version = "0.1.2"
+version = "0.1.4"
 authors = [
   { name="Code Ocean", email="dev@codeocean.com" },
 ]
 description = "Code Ocean Python SDK"
 readme = "README.md"
-requires-python = ">=3.11"
+requires-python = ">=3.9"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: MIT License",
@@ -21,12 +21,12 @@ dependencies = [
     "dataclasses_json",
     "requests",
     "requests_toolbelt",
+    "backports.strenum>=1.3.1; python_version<'3.11'",
 ]
 license = "MIT"
 
 [project.optional-dependencies]
-dev = ["flake8"]
-publish = ["hatch"]
+dev = ["flake8", "hatch"]
 
 [project.urls]
 Homepage = "https://github.com/codeocean/codeocean-sdk-python"
@@ -45,3 +45,10 @@ exclude = [
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/codeocean"]
+
+[tool.hatch.envs.default.scripts]
+lint = "flake8 src tests examples"
+test = "python -m unittest -v"
+
+[[tool.hatch.envs.test.matrix]]
+python = ["3.9", "3.10", "3.11", "3.12"]

{codeocean-0.1.2 → codeocean-0.1.4}/src/codeocean/capsule.py

@@ -1,77 +1,82 @@
-from dataclasses import dataclass
-from dataclasses_json import dataclass_json
-from enum import StrEnum
-from typing import Optional
-from requests_toolbelt.sessions import BaseUrlSession
-
-from codeocean.computation import Computation
-from codeocean.data_asset import DataAssetAttachParams, DataAssetAttachResults
-
-
-class CapsuleStatus(StrEnum):
-    NonPublished = "non-published"
-    Submitted = "submitted"
-    Publishing = "publishing"
-    Published = "published"
-    Verified = "verified"
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class OriginalCapsuleInfo:
-    id: Optional[str] = None
-    major_version: Optional[int] = None
-    minor_version: Optional[int] = None
-    name: Optional[str] = None
-    created: Optional[int] = None
-    public: Optional[bool] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class Capsule:
-    id: str
-    created: int
-    name: str
-    status: CapsuleStatus
-    owner: str
-    slug: str
-    article: Optional[dict] = None
-    cloned_from_url: Optional[str] = None
-    description: Optional[str] = None
-    field: Optional[str] = None
-    keywords: Optional[list[str]] = None
-    original_capsule: Optional[OriginalCapsuleInfo] = None
-    published_capsule: Optional[str] = None
-    submission: Optional[dict] = None
-    versions: Optional[list[dict]] = None
-
-
-@dataclass
-class Capsules:
-
-    client: BaseUrlSession
-
-    def get_capsule(self, capsule_id: str) -> Capsule:
-        res = self.client.get(f"capsules/{capsule_id}")
-
-        return Capsule.from_dict(res.json())
-
-    def list_computations(self, capsule_id: str) -> list[Computation]:
-        res = self.client.get(f"capsules/{capsule_id}/computations")
-
-        return [Computation.from_dict(c) for c in res.json()]
-
-    def attach_data_assets(self, capsule_id: str, attach_params: list[DataAssetAttachParams]) -> DataAssetAttachResults:
-        res = self.client.post(
-            f"capsules/{capsule_id}/data_assets",
-            json=[j.to_dict() for j in attach_params],
-        )
-
-        return DataAssetAttachResults.from_dict(res.json())
-
-    def detach_data_assets(self, capsule_id: str, data_assets: list[str]):
-        self.client.delete(
-            f"capsules/{capsule_id}/data_assets/",
-            json=data_assets,
-        )
+from __future__ import annotations
+
+from dataclasses import dataclass
+from dataclasses_json import dataclass_json
+from typing import Optional
+from requests_toolbelt.sessions import BaseUrlSession
+
+from codeocean.computation import Computation
+from codeocean.data_asset import DataAssetAttachParams, DataAssetAttachResults
+from codeocean.enum import StrEnum
+
+
+class CapsuleStatus(StrEnum):
+    NonPublished = "non-published"
+    Submitted = "submitted"
+    Publishing = "publishing"
+    Published = "published"
+    Verified = "verified"
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class OriginalCapsuleInfo:
+    id: Optional[str] = None
+    major_version: Optional[int] = None
+    minor_version: Optional[int] = None
+    name: Optional[str] = None
+    created: Optional[int] = None
+    public: Optional[bool] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class Capsule:
+    id: str
+    created: int
+    name: str
+    status: CapsuleStatus
+    owner: str
+    slug: str
+    article: Optional[dict] = None
+    cloned_from_url: Optional[str] = None
+    description: Optional[str] = None
+    field: Optional[str] = None
+    keywords: Optional[list[str]] = None
+    original_capsule: Optional[OriginalCapsuleInfo] = None
+    published_capsule: Optional[str] = None
+    submission: Optional[dict] = None
+    versions: Optional[list[dict]] = None
+
+
+@dataclass
+class Capsules:
+
+    client: BaseUrlSession
+
+    def get_capsule(self, capsule_id: str) -> Capsule:
+        res = self.client.get(f"capsules/{capsule_id}")
+
+        return Capsule.from_dict(res.json())
+
+    def list_computations(self, capsule_id: str) -> list[Computation]:
+        res = self.client.get(f"capsules/{capsule_id}/computations")
+
+        return [Computation.from_dict(c) for c in res.json()]
+
+    def attach_data_assets(
+            self,
+            capsule_id: str,
+            attach_params: list[DataAssetAttachParams]) -> list[DataAssetAttachResults]:
+        res = self.client.post(
+            f"capsules/{capsule_id}/data_assets",
+            json=[j.to_dict() for j in attach_params],
+        )
+
+        return [DataAssetAttachResults.from_dict(c) for c in res.json()]
+
+    def detach_data_assets(self, capsule_id: str, data_assets: list[str]):
+        self.client.delete(
+            f"capsules/{capsule_id}/data_assets/",
+            json=data_assets,
+        )

{codeocean-0.1.2 → codeocean-0.1.4}/src/codeocean/client.py

@@ -1,25 +1,27 @@
-from requests_toolbelt.sessions import BaseUrlSession
-from dataclasses import dataclass
-
-from codeocean.capsule import Capsules
-from codeocean.computation import Computations
-from codeocean.data_asset import DataAssets
-
-
-@dataclass
-class CodeOcean:
-
-    domain: str
-    token: str
-
-    def __post_init__(self):
-        self.session = BaseUrlSession(base_url=f"{self.domain}/api/v1/")
-        self.session.auth = (self.token, "")
-        self.session.headers.update({"Content-Type": "application/json"})
-        self.session.hooks["response"] = [
-            lambda response, *args, **kwargs: response.raise_for_status()
-        ]
-
-        self.capsules = Capsules(client=self.session)
-        self.computations = Computations(client=self.session)
-        self.data_assets = DataAssets(client=self.session)
+from requests_toolbelt.sessions import BaseUrlSession
+from requests_toolbelt.adapters.socket_options import TCPKeepAliveAdapter
+from dataclasses import dataclass
+
+from codeocean.capsule import Capsules
+from codeocean.computation import Computations
+from codeocean.data_asset import DataAssets
+
+
+@dataclass
+class CodeOcean:
+
+    domain: str
+    token: str
+
+    def __post_init__(self):
+        self.session = BaseUrlSession(base_url=f"{self.domain}/api/v1/")
+        self.session.auth = (self.token, "")
+        self.session.mount(self.domain, TCPKeepAliveAdapter())
+        self.session.headers.update({"Content-Type": "application/json"})
+        self.session.hooks["response"] = [
+            lambda response, *args, **kwargs: response.raise_for_status()
+        ]
+
+        self.capsules = Capsules(client=self.session)
+        self.computations = Computations(client=self.session)
+        self.data_assets = DataAssets(client=self.session)

{codeocean-0.1.2 → codeocean-0.1.4}/src/codeocean/components.py

@@ -1,8 +1,11 @@
+from __future__ import annotations
+
 from dataclasses_json import dataclass_json
 from dataclasses import dataclass
-from enum import StrEnum
 from typing import Optional
 
+from codeocean.enum import StrEnum
+
 
 class UserRole(StrEnum):
     Owner = "owner"

{codeocean-0.1.2 → codeocean-0.1.4}/src/codeocean/computation.py

@@ -1,171 +1,174 @@
-from dataclasses import dataclass
-from dataclasses_json import dataclass_json
-from enum import StrEnum
-from requests_toolbelt.sessions import BaseUrlSession
-from typing import Optional
-from time import sleep
-
-
-class ComputationState(StrEnum):
-    Initializing = "initializing"
-    Running = "running"
-    Finalizing = "finalizing"
-    Completed = "completed"
-    Failed = "failed"
-
-
-class ComputationEndStatus(StrEnum):
-    Succeeded = "succeeded"
-    Failed = "failed"
-    Stopped = "stopped"
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class Param:
-    name: Optional[str] = None
-    param_name: Optional[str] = None
-    value: Optional[str] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class PipelineProcess:
-    name: str
-    capsule_id: str
-    version: Optional[int] = None
-    public: Optional[bool] = None
-    parameters: Optional[list[Param]] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class InputDataAsset:
-    id: str
-    mount: Optional[str] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class Computation:
-    id: str
-    created: int
-    name: str
-    state: ComputationState
-    run_time: int
-    cloud_workstation: Optional[bool] = None
-    data_assets: Optional[list[InputDataAsset]] = None
-    end_status: Optional[ComputationEndStatus] = None
-    has_results: Optional[bool] = None
-    parameters: Optional[list[Param]] = None
-    processes: Optional[list[PipelineProcess]] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class DataAssetsRunParam:
-    id: str
-    mount: str
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class NamedRunParam:
-    param_name: str
-    value: str
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class PipelineProcessParams:
-    name: str
-    parameters: Optional[list[str]] = None
-    named_parameters: Optional[list[NamedRunParam]] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class RunParams:
-    capsule_id: Optional[str] = None
-    pipeline_id: Optional[str] = None
-    version: Optional[int] = None
-    resume_run_id: Optional[str] = None
-    data_assets: Optional[list[DataAssetsRunParam]] = None
-    parameters: Optional[list[str]] = None
-    named_parameters: Optional[list[NamedRunParam]] = None
-    processes: Optional[list[PipelineProcessParams]] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class FolderItem:
-    name: str
-    path: str
-    type: str
-    size: Optional[int] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class Folder:
-    items: list[FolderItem]
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class ListFolderParams:
-    path: str
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class DownloadFileURL:
-    url: str
-
-
-@dataclass
-class Computations:
-
-    client: BaseUrlSession
-
-    def get_computation(self, computation_id: str) -> Computation:
-        res = self.client.get(f"computations/{computation_id}")
-
-        return Computation.from_dict(res.json())
-
-    def run_capsule(self, run_params: RunParams) -> Computation:
-        res = self.client.post("computations", json=run_params.to_dict())
-
-        return Computation.from_dict(res.json())
-
-    def wait_until_completed(self, computation: Computation) -> Computation:
-        """
-        Polls the given computation until it reaches the 'Completed' or 'Failed' state.
-        """
-        while True:
-            comp = self.get_computation(computation.id)
-
-            if comp.state in [ComputationState.Completed, ComputationState.Failed]:
-                return comp
-
-            sleep(5)
-
-    def list_computation_results(self, computation_id: str, path: str = "") -> Folder:
-        data = {
-            "path": path,
-        }
-
-        res = self.client.post(f"computations/{computation_id}/results", json=data)
-
-        return Folder.from_dict(res.json())
-
-    def get_result_file_download_url(self, computation_id: str, path: str) -> DownloadFileURL:
-        res = self.client.get(
-            f"computations/{computation_id}/results/download_url",
-            params={"path": path},
-        )
-
-        return DownloadFileURL.from_dict(res.json())
-
-    def delete_computation(self, computation_id: str):
-        self.client.delete(f"computations/{computation_id}")
+from __future__ import annotations
+
+from dataclasses import dataclass
+from dataclasses_json import dataclass_json
+from requests_toolbelt.sessions import BaseUrlSession
+from typing import Optional
+from time import sleep
+
+from codeocean.enum import StrEnum
+
+
+class ComputationState(StrEnum):
+    Initializing = "initializing"
+    Running = "running"
+    Finalizing = "finalizing"
+    Completed = "completed"
+    Failed = "failed"
+
+
+class ComputationEndStatus(StrEnum):
+    Succeeded = "succeeded"
+    Failed = "failed"
+    Stopped = "stopped"
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class Param:
+    name: Optional[str] = None
+    param_name: Optional[str] = None
+    value: Optional[str] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class PipelineProcess:
+    name: str
+    capsule_id: str
+    version: Optional[int] = None
+    public: Optional[bool] = None
+    parameters: Optional[list[Param]] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class InputDataAsset:
+    id: str
+    mount: Optional[str] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class Computation:
+    id: str
+    created: int
+    name: str
+    state: ComputationState
+    run_time: int
+    cloud_workstation: Optional[bool] = None
+    data_assets: Optional[list[InputDataAsset]] = None
+    end_status: Optional[ComputationEndStatus] = None
+    has_results: Optional[bool] = None
+    parameters: Optional[list[Param]] = None
+    processes: Optional[list[PipelineProcess]] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class DataAssetsRunParam:
+    id: str
+    mount: str
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class NamedRunParam:
+    param_name: str
+    value: str
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class PipelineProcessParams:
+    name: str
+    parameters: Optional[list[str]] = None
+    named_parameters: Optional[list[NamedRunParam]] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class RunParams:
+    capsule_id: Optional[str] = None
+    pipeline_id: Optional[str] = None
+    version: Optional[int] = None
+    resume_run_id: Optional[str] = None
+    data_assets: Optional[list[DataAssetsRunParam]] = None
+    parameters: Optional[list[str]] = None
+    named_parameters: Optional[list[NamedRunParam]] = None
+    processes: Optional[list[PipelineProcessParams]] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class FolderItem:
+    name: str
+    path: str
+    type: str
+    size: Optional[int] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class Folder:
+    items: list[FolderItem]
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class ListFolderParams:
+    path: str
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class DownloadFileURL:
+    url: str
+
+
+@dataclass
+class Computations:
+
+    client: BaseUrlSession
+
+    def get_computation(self, computation_id: str) -> Computation:
+        res = self.client.get(f"computations/{computation_id}")
+
+        return Computation.from_dict(res.json())
+
+    def run_capsule(self, run_params: RunParams) -> Computation:
+        res = self.client.post("computations", json=run_params.to_dict())
+
+        return Computation.from_dict(res.json())
+
+    def wait_until_completed(self, computation: Computation) -> Computation:
+        """
+        Polls the given computation until it reaches the 'Completed' or 'Failed' state.
+        """
+        while True:
+            comp = self.get_computation(computation.id)
+
+            if comp.state in [ComputationState.Completed, ComputationState.Failed]:
+                return comp
+
+            sleep(5)
+
+    def list_computation_results(self, computation_id: str, path: str = "") -> Folder:
+        data = {
+            "path": path,
+        }
+
+        res = self.client.post(f"computations/{computation_id}/results", json=data)
+
+        return Folder.from_dict(res.json())
+
+    def get_result_file_download_url(self, computation_id: str, path: str) -> DownloadFileURL:
+        res = self.client.get(
+            f"computations/{computation_id}/results/download_url",
+            params={"path": path},
+        )
+
+        return DownloadFileURL.from_dict(res.json())
+
+    def delete_computation(self, computation_id: str):
+        self.client.delete(f"computations/{computation_id}")

{codeocean-0.1.2 → codeocean-0.1.4}/src/codeocean/data_asset.py

@@ -1,252 +1,270 @@
-from dataclasses_json import dataclass_json
-from dataclasses import dataclass
-from enum import StrEnum
-from requests_toolbelt.sessions import BaseUrlSession
-from time import sleep
-from typing import Optional
-
-from codeocean.components import SortOrder, SearchFilter, Permissions
-
-
-class DataAssetType(StrEnum):
-    Dataset = "dataset"
-    Result = "result"
-
-
-class DataAssetState(StrEnum):
-    Draft = "draft"
-    Ready = "ready"
-    Failed = "failed"
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class Provenance:
-    commit: str
-    run_script: str
-    data_assets: str
-    docker_image: str
-    capsule: str
-
-
-class DataAssetOrigin(StrEnum):
-    Local = "local"
-    AWS = "aws"
-    GCP = "gcp"
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class SourceBucket:
-    origin: DataAssetOrigin
-    bucket: str
-    prefix: str
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class AppParameter:
-    name: str
-    value: str
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class DataAsset:
-    id: str
-    created: int
-    name: str
-    mount: str
-    state: DataAssetState
-    type: DataAssetType
-    last_used: int
-    app_parameters: Optional[list[AppParameter]] = None
-    custom_metadata: Optional[dict] = None
-    description: Optional[str] = None
-    failure_reason: Optional[str] = None
-    files: Optional[int] = None
-    provenance: Optional[Provenance] = None
-    size: Optional[int] = None
-    source_bucket: Optional[SourceBucket] = None
-    tags: Optional[list[str]] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class DataAssetUpdateParams:
-    name: str
-    description: str
-    tags: list[str]
-    mount: str
-    custom_metadata: Optional[dict] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class AWSS3Source:
-    bucket: str
-    prefix: Optional[str] = None
-    keep_on_external_storage: Optional[bool] = None
-    public: Optional[bool] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class GCPCloudStorageSource:
-    bucket: str
-    client_id: Optional[str] = None
-    client_secret: Optional[str] = None
-    prefix: Optional[str] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class ComputationSource:
-    id: str
-    path: Optional[str] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class Source:
-    aws: Optional[AWSS3Source] = None
-    gcp: Optional[GCPCloudStorageSource] = None
-    computation: Optional[ComputationSource] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class AWSS3Target:
-    bucket: str
-    prefix: Optional[str] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class Target:
-    aws: Optional[AWSS3Target] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class DataAssetParams:
-    name: str
-    tags: list[str]
-    mount: str
-    description: Optional[str] = None
-    source: Optional[Source] = None
-    target: Optional[Target] = None
-    custom_metadata: Optional[dict] = None
-    data_asset_ids: Optional[list[str]] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class DataAssetAttachParams:
-    id: str
-    mount: Optional[str] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class DataAssetAttachResults:
-    id: str
-    mount: str
-    mount_state: str
-    job_id: str
-    external: bool
-    ready: bool
-
-
-class DataAssetSortBy(StrEnum):
-    Created = "created"
-    Type = "type"
-    Name = "name"
-    Size = "size"
-
-
-class DataAssetOwnership(StrEnum):
-    Private = "private"
-    Shared = "shared"
-    Created = "created"
-
-
-class DataAssetSearchOrigin(StrEnum):
-    Internal = "internal"
-    External = "external"
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class DataAssetSearchParams:
-    limit: int
-    offset: int
-    archived: bool
-    favorite: bool
-    query: Optional[str] = None
-    sort_field: Optional[DataAssetSortBy] = None
-    sort_order: Optional[SortOrder] = None
-    type: Optional[DataAssetType] = None
-    ownership: Optional[DataAssetOwnership] = None
-    origin: Optional[DataAssetSearchOrigin] = None
-    filters: Optional[list[SearchFilter]] = None
-
-
-@dataclass_json
-@dataclass(frozen=True)
-class DataAssetSearchResults:
-    has_more: bool
-    results: list[DataAsset]
-
-
-@dataclass
-class DataAssets:
-
-    client: BaseUrlSession
-
-    def get_data_asset(self, data_asset_id: str) -> DataAsset:
-        res = self.client.get(f"data_assets/{data_asset_id}")
-
-        return DataAsset.from_dict(res.json())
-
-    def update_metadata(self, data_asset_id: str, update_params: DataAssetUpdateParams) -> DataAsset:
-        res = self.client.put(f"data_assets/{data_asset_id}", json=update_params.to_dict())
-
-        return DataAsset.from_dict(res.json())
-
-    def create_data_asset(self, data_asset_params: DataAssetParams) -> DataAsset:
-        res = self.client.post("data_assets", json=data_asset_params.to_dict())
-
-        return DataAsset.from_dict(res.json())
-
-    def wait_until_ready(self, data_asset: DataAsset) -> DataAsset:
-        """
-        Polls the given data asset until it reaches the 'Ready' or 'Failed' state.
-        """
-        while True:
-            da = self.get_data_asset(data_asset.id)
-
-            if da.state in [DataAssetState.Ready, DataAssetState.Failed]:
-                return da
-
-            sleep(5)
-
-    def delete_data_asset(self, data_asset_id: str):
-        self.client.delete(f"data_assets/{data_asset_id}")
-
-    def update_permissions(self, data_asset_id: str, permissions: Permissions):
-        self.client.post(
-            f"data_assets/{data_asset_id}/permissions",
-            json=permissions.to_dict(),
-        )
-
-    def archive_data_asset(self, data_asset_id: str, archive: bool):
-        self.client.patch(
-            f"data_assets/{data_asset_id}/archive",
-            params={"archive": archive},
-        )
-
-    def search_data_assets(self, search_params: DataAssetSearchParams) -> DataAssetSearchResults:
-        res = self.client.post("data_assets/search", json=search_params.to_dict())
-
-        return DataAssetSearchResults.from_dict(res.json())
+from __future__ import annotations
+
+from dataclasses_json import dataclass_json
+from dataclasses import dataclass
+from requests_toolbelt.sessions import BaseUrlSession
+from time import sleep
+from typing import Optional
+
+from codeocean.components import SortOrder, SearchFilter, Permissions
+from codeocean.computation import PipelineProcess, Param
+from codeocean.enum import StrEnum
+
+
+class DataAssetType(StrEnum):
+    Dataset = "dataset"
+    Result = "result"
+
+
+class DataAssetState(StrEnum):
+    Draft = "draft"
+    Ready = "ready"
+    Failed = "failed"
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class Provenance:
+    commit: str
+    run_script: str
+    data_assets: str
+    docker_image: str
+    capsule: str
+
+
+class DataAssetOrigin(StrEnum):
+    Local = "local"
+    AWS = "aws"
+    GCP = "gcp"
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class SourceBucket:
+    origin: DataAssetOrigin
+    bucket: Optional[str] = None
+    prefix: Optional[str] = None
+    external: Optional[bool] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class AppParameter:
+    name: str
+    value: str
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class ResultsInfo:
+    capsule_id: Optional[str] = None
+    pipeline_id: Optional[str] = None
+    version: Optional[int] = None
+    commit: Optional[str] = None
+    run_script: Optional[str] = None
+    data_assets: Optional[list[str]] = None
+    parameters: Optional[list[Param]] = None
+    processes: Optional[list[PipelineProcess]] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class DataAsset:
+    id: str
+    created: int
+    name: str
+    mount: str
+    state: DataAssetState
+    type: DataAssetType
+    last_used: int
+    app_parameters: Optional[list[AppParameter]] = None
+    custom_metadata: Optional[dict] = None
+    description: Optional[str] = None
+    failure_reason: Optional[str] = None
+    files: Optional[int] = None
+    provenance: Optional[Provenance] = None
+    size: Optional[int] = None
+    source_bucket: Optional[SourceBucket] = None
+    tags: Optional[list[str]] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class DataAssetUpdateParams:
+    name: str
+    description: str
+    tags: list[str]
+    mount: str
+    custom_metadata: Optional[dict] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class AWSS3Source:
+    bucket: str
+    prefix: Optional[str] = None
+    keep_on_external_storage: Optional[bool] = None
+    public: Optional[bool] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class GCPCloudStorageSource:
+    bucket: str
+    client_id: Optional[str] = None
+    client_secret: Optional[str] = None
+    prefix: Optional[str] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class ComputationSource:
+    id: str
+    path: Optional[str] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class Source:
+    aws: Optional[AWSS3Source] = None
+    gcp: Optional[GCPCloudStorageSource] = None
+    computation: Optional[ComputationSource] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class AWSS3Target:
+    bucket: str
+    prefix: Optional[str] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class Target:
+    aws: Optional[AWSS3Target] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class DataAssetParams:
+    name: str
+    tags: list[str]
+    mount: str
+    description: Optional[str] = None
+    source: Optional[Source] = None
+    target: Optional[Target] = None
+    custom_metadata: Optional[dict] = None
+    data_asset_ids: Optional[list[str]] = None
+    results_info: Optional[ResultsInfo] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class DataAssetAttachParams:
+    id: str
+    mount: Optional[str] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class DataAssetAttachResults:
+    id: str
+    mount: str
+    mount_state: str
+    job_id: str
+    external: bool
+    ready: bool
+
+
+class DataAssetSortBy(StrEnum):
+    Created = "created"
+    Type = "type"
+    Name = "name"
+    Size = "size"
+
+
+class DataAssetOwnership(StrEnum):
+    Private = "private"
+    Shared = "shared"
+    Created = "created"
+
+
+class DataAssetSearchOrigin(StrEnum):
+    Internal = "internal"
+    External = "external"
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class DataAssetSearchParams:
+    limit: int
+    offset: int
+    archived: bool
+    favorite: bool
+    query: Optional[str] = None
+    sort_field: Optional[DataAssetSortBy] = None
+    sort_order: Optional[SortOrder] = None
+    type: Optional[DataAssetType] = None
+    ownership: Optional[DataAssetOwnership] = None
+    origin: Optional[DataAssetSearchOrigin] = None
+    filters: Optional[list[SearchFilter]] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class DataAssetSearchResults:
+    has_more: bool
+    results: list[DataAsset]
+
+
+@dataclass
+class DataAssets:
+
+    client: BaseUrlSession
+
+    def get_data_asset(self, data_asset_id: str) -> DataAsset:
+        res = self.client.get(f"data_assets/{data_asset_id}")
+
+        return DataAsset.from_dict(res.json())
+
+    def update_metadata(self, data_asset_id: str, update_params: DataAssetUpdateParams) -> DataAsset:
+        res = self.client.put(f"data_assets/{data_asset_id}", json=update_params.to_dict())
+
+        return DataAsset.from_dict(res.json())
+
+    def create_data_asset(self, data_asset_params: DataAssetParams) -> DataAsset:
+        res = self.client.post("data_assets", json=data_asset_params.to_dict())
+
+        return DataAsset.from_dict(res.json())
+
+    def wait_until_ready(self, data_asset: DataAsset) -> DataAsset:
+        """
+        Polls the given data asset until it reaches the 'Ready' or 'Failed' state.
+        """
+        while True:
+            da = self.get_data_asset(data_asset.id)
+
+            if da.state in [DataAssetState.Ready, DataAssetState.Failed]:
+                return da
+
+            sleep(5)
+
+    def delete_data_asset(self, data_asset_id: str):
+        self.client.delete(f"data_assets/{data_asset_id}")
+
+    def update_permissions(self, data_asset_id: str, permissions: Permissions):
+        self.client.post(
+            f"data_assets/{data_asset_id}/permissions",
+            json=permissions.to_dict(),
+        )
+
+    def archive_data_asset(self, data_asset_id: str, archive: bool):
+        self.client.patch(
+            f"data_assets/{data_asset_id}/archive",
+            params={"archive": archive},
+        )
+
+    def search_data_assets(self, search_params: DataAssetSearchParams) -> DataAssetSearchResults:
+        res = self.client.post("data_assets/search", json=search_params.to_dict())
+
+        return DataAssetSearchResults.from_dict(res.json())

codeocean-0.1.4/src/codeocean/enum.py

@@ -0,0 +1,6 @@
+import sys
+
+if sys.version_info >= (3, 11):
+    from enum import StrEnum
+else:
+    from backports.strenum import StrEnum  # noqa

codeocean-0.1.4/tests/test_package.py

@@ -0,0 +1,23 @@
+import sys
+import unittest
+
+
+class TestPackage(unittest.TestCase):
+    def test_import_package(self):
+        import codeocean  # noqa
+
+    def test_strenum_install(self):
+        """
+        Check if the StrEnum backport is installed/not installed as appropriate in the test environment.
+
+        - the backport can only be installed for Python versions < 3.11 (https://pypi.org/project/backports.strenum/)
+        - for >= 3.11, the stdlib StrEnum should be used instead
+        """
+        if sys.version_info >= (3, 11):
+            with self.assertRaises(ImportError):
+                import backports.strenum  # noqa
+        else:
+            try:
+                import backports.strenum  # noqa
+            except ImportError:
+                self.fail("Failed to import the backports.strenum module")

codeocean-0.1.2/CHANGELOG.md

@@ -1,10 +0,0 @@
-CHANGELOG
-=========
-
-## 0.1.2 (2024-03-20)
-
-- Fix minimum required Pyhton version (3.11)
-
-## 0.1.0 (2024-03-18)
-
-Initial version