codeocean 0.2.0__tar.gz → 0.3.1__tar.gz

{codeocean-0.2.0 → codeocean-0.3.1}/CHANGELOG.md

@@ -1,6 +1,21 @@
 CHANGELOG
 =========
 
+## 0.3.1 (2025-01-30)
+- [#31](https://github.com/codeocean/codeocean-sdk-python/pull/31) fix: set fields as optional fields according to openapi spec
+- [#30](https://github.com/codeocean/codeocean-sdk-python/pull/30) fix: make all DataAssetUpdateParams fields optional
+- [#29](https://github.com/codeocean/codeocean-sdk-python/pull/29) Add SDK compatibility details
+
+## 0.3.0 (2025-01-07)
+
+- [#25](https://github.com/codeocean/codeocean-sdk-python/pull/25) feat: Add support for Python 3.13
+- [#24](https://github.com/codeocean/codeocean-sdk-python/pull/24) feat: Paginated data asset search
+- [#22](https://github.com/codeocean/codeocean-sdk-python/pull/22) feat: add support for rename computation API
+- [#21](https://github.com/codeocean/codeocean-sdk-python/pull/21) feat: Code Ocean Version 3.1 updates
+- [#18](https://github.com/codeocean/codeocean-sdk-python/pull/18) feat: Combined data asset
+- [#16](https://github.com/codeocean/codeocean-sdk-python/pull/16) fix: revert default number of retries to 0
+- **Minimum Code Ocean platform version updated to `3.1.0`.**  
+
 ## 0.2.0 (2024-10-21)
 
 - [#15](https://github.com/codeocean/codeocean-sdk-python/pull/15) feat: Add option for custom retries

{codeocean-0.2.0 → codeocean-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: codeocean
-Version: 0.2.0
+Version: 0.3.1
 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
@@ -13,7 +13,6 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 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
@@ -42,3 +41,10 @@ For development, install from source with:
 ```sh
 pip install -e .[dev] -U
 ```
+
+## Code Ocean Python SDK Version Compatibility
+
+Each release of this Code Ocean Python SDK is tested and verified against a specific minimum version of the Code Ocean platform API.
+Generally, this minimum version is the latest Code Ocean version at the time of the SDK’s release.
+We recommend ensuring your SDK dependency is pinned to a version compatible with your Code Ocean deployment.
+For details on when the minimum Code Ocean platform version changes, see the [CHANGELOG](CHANGELOG.md).

{codeocean-0.2.0 → codeocean-0.3.1}/README.md

@@ -18,3 +18,10 @@ For development, install from source with:
 ```sh
 pip install -e .[dev] -U
 ```
+
+## Code Ocean Python SDK Version Compatibility
+
+Each release of this Code Ocean Python SDK is tested and verified against a specific minimum version of the Code Ocean platform API.
+Generally, this minimum version is the latest Code Ocean version at the time of the SDK’s release.
+We recommend ensuring your SDK dependency is pinned to a version compatible with your Code Ocean deployment.
+For details on when the minimum Code Ocean platform version changes, see the [CHANGELOG](CHANGELOG.md).

codeocean-0.3.1/RELEASE.md

@@ -0,0 +1,24 @@
+# Version Release Process
+
+1. Open a PR with the following changes:
+    1. Bump the version in [pyproject.toml](pyproject.toml).
+    1. Update the [CHANGELOG.md](CHANGELOG.md).
+    1. Commit the updates with the message `Bump version to X.Y.Z`.
+1. Merge the PR.
+1. Locally, sync your clone with GitHub:
+    ```
+    git fetch origin
+    git checkout main
+    git reset --hard origin/main
+    ```
+1. Tag the release:
+    ```
+    git tag vX.Y.Z -m "vX.Y.Z"
+    ```
+1. Push changes:
+    ```
+    git push origin vX.Y.Z
+    ```
+
+    This will trigger a workflow on CircleCI that will generate a GitHub release
+    and publish the new version to PyPI.

{codeocean-0.2.0 → codeocean-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "codeocean"
-version = "0.2.0"
+version = "0.3.1"
 authors = [
   { name="Code Ocean", email="dev@codeocean.com" },
 ]
@@ -17,8 +17,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "dataclasses",
-    "dataclasses_json",
+    "dataclasses-json",
     "requests",
     "requests_toolbelt",
     "backports.strenum>=1.3.1; python_version<'3.11'",
@@ -51,4 +50,4 @@ lint = "flake8 src tests examples"
 test = "python -m unittest -v"
 
 [[tool.hatch.envs.test.matrix]]
-python = ["3.9", "3.10", "3.11", "3.12"]
+python = ["3.9", "3.10", "3.11", "3.12", "3.13"]

{codeocean-0.2.0 → codeocean-0.3.1}/src/codeocean/capsule.py

@@ -5,17 +5,21 @@ from dataclasses_json import dataclass_json
 from typing import Optional
 from requests_toolbelt.sessions import BaseUrlSession
 
+from codeocean.components import Ownership, SortOrder, SearchFilter
 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"
+    NonRelease = "non_release"
+    Release = "release"
+
+
+class CapsuleSortBy(StrEnum):
+    Created = "created"
+    LastAccessed = "last_accessed"
+    Name = "name"
 
 
 @dataclass_json
@@ -42,13 +46,37 @@ class Capsule:
     cloned_from_url: Optional[str] = None
     description: Optional[str] = None
     field: Optional[str] = None
-    keywords: Optional[list[str]] = None
+    tags: Optional[list[str]] = None
     original_capsule: Optional[OriginalCapsuleInfo] = None
-    published_capsule: Optional[str] = None
+    release_capsule: Optional[str] = None
     submission: Optional[dict] = None
     versions: Optional[list[dict]] = None
 
 
+@dataclass_json
+@dataclass(frozen=True)
+class CapsuleSearchParams:
+    query: Optional[str] = None
+    next_token: Optional[str] = None
+    offset: Optional[int] = None
+    limit: Optional[int] = None
+    sort_field: Optional[CapsuleSortBy] = None
+    sort_order: Optional[SortOrder] = None
+    ownership: Optional[Ownership] = None
+    status: Optional[CapsuleStatus] = None
+    favorite: Optional[bool] = None
+    archived: Optional[bool] = None
+    filters: Optional[list[SearchFilter]] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class CapsuleSearchResults:
+    has_more: bool
+    results: list[Capsule]
+    next_token: Optional[str] = None
+
+
 @dataclass
 class Capsules:
 
@@ -80,3 +108,8 @@ class Capsules:
             f"capsules/{capsule_id}/data_assets/",
             json=data_assets,
         )
+
+    def search_capsules(self, search_params: CapsuleSearchParams) -> CapsuleSearchResults:
+        res = self.client.post("capsules/search", json=search_params.to_dict())
+
+        return CapsuleSearchResults.from_dict(res.json())

{codeocean-0.2.0 → codeocean-0.3.1}/src/codeocean/client.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dataclasses import dataclass
 from requests_toolbelt.adapters.socket_options import TCPKeepAliveAdapter
 from requests_toolbelt.sessions import BaseUrlSession
@@ -14,7 +16,7 @@ class CodeOcean:
 
     domain: str
     token: str
-    retries: Optional[Retry] = None
+    retries: Optional[Retry | int] = 0
 
     def __post_init__(self):
         self.session = BaseUrlSession(base_url=f"{self.domain}/api/v1/")

{codeocean-0.2.0 → codeocean-0.3.1}/src/codeocean/components.py

@@ -69,3 +69,9 @@ class SearchFilter:
     values: Optional[list[str | float]] = None
     range: Optional[SearchFilterRange] = None
     exclude: Optional[bool] = None
+
+
+class Ownership(StrEnum):
+    Private = "private"
+    Shared = "shared"
+    Created = "created"

{codeocean-0.2.0 → codeocean-0.3.1}/src/codeocean/computation.py

@@ -7,6 +7,7 @@ from typing import Optional
 from time import sleep, time
 
 from codeocean.enum import StrEnum
+from codeocean.folder import Folder, DownloadFileURL
 
 
 class ComputationState(StrEnum):
@@ -54,14 +55,15 @@ class Computation:
     id: str
     created: int
     name: str
-    state: ComputationState
     run_time: int
+    state: ComputationState
     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
+    end_status: Optional[ComputationEndStatus] = None
+    exit_code: Optional[int] = None
+    has_results: Optional[bool] = None
 
 
 @dataclass_json
@@ -99,33 +101,6 @@ class RunParams:
     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:
 
@@ -195,3 +170,9 @@ class Computations:
 
     def delete_computation(self, computation_id: str):
         self.client.delete(f"computations/{computation_id}")
+
+    def rename_computation(self, computation_id: str, name: str):
+        self.client.patch(
+            f"computations/{computation_id}",
+            params={"name": name}
+            )

{codeocean-0.2.0 → codeocean-0.3.1}/src/codeocean/data_asset.py

@@ -4,16 +4,19 @@ from dataclasses_json import dataclass_json
 from dataclasses import dataclass
 from requests_toolbelt.sessions import BaseUrlSession
 from time import sleep, time
-from typing import Optional
+from typing import Optional, Iterator
 
-from codeocean.components import SortOrder, SearchFilter, Permissions
+from codeocean.components import Ownership, SortOrder, SearchFilter, Permissions
 from codeocean.computation import PipelineProcess, Param
 from codeocean.enum import StrEnum
+from codeocean.folder import Folder, DownloadFileURL
 
 
 class DataAssetType(StrEnum):
     Dataset = "dataset"
     Result = "result"
+    Combined = "combined"
+    Model = "model"
 
 
 class DataAssetState(StrEnum):
@@ -25,10 +28,10 @@ class DataAssetState(StrEnum):
 @dataclass_json
 @dataclass(frozen=True)
 class Provenance:
-    commit: str
-    run_script: str
-    docker_image: str
-    capsule: str
+    commit: Optional[str] = None
+    run_script: Optional[str] = None
+    docker_image: Optional[str] = None
+    capsule: Optional[str] = None
     data_assets: Optional[list[str]] = None
 
 
@@ -50,8 +53,8 @@ class SourceBucket:
 @dataclass_json
 @dataclass(frozen=True)
 class AppParameter:
-    name: str
-    value: str
+    name: Optional[str] = None
+    value: Optional[str] = None
 
 
 @dataclass_json
@@ -77,24 +80,27 @@ class DataAsset:
     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
+    description: Optional[str] = None
     tags: Optional[list[str]] = None
+    provenance: Optional[Provenance] = None
+    source_bucket: Optional[SourceBucket] = None
+    custom_metadata: Optional[dict] = None
+    app_parameters: Optional[list[AppParameter]] = None
+    contained_data_assets: Optional[list[ContainedDataAsset]] = None
+    last_transferred: Optional[int] = None
+    transfer_error: Optional[str] = None
+    failure_reason: Optional[str] = None
 
 
 @dataclass_json
 @dataclass(frozen=True)
 class DataAssetUpdateParams:
-    name: str
-    description: str
-    tags: list[str]
-    mount: str
+    name: Optional[str] = None
+    description: Optional[str] = None
+    tags: Optional[list[str]] = None
+    mount: Optional[str] = None
     custom_metadata: Optional[dict] = None
 
 
@@ -169,11 +175,11 @@ class DataAssetAttachParams:
 @dataclass(frozen=True)
 class DataAssetAttachResults:
     id: str
-    mount: str
-    mount_state: str
-    job_id: str
-    external: bool
-    ready: bool
+    mount_state: Optional[str] = None
+    job_id: Optional[str] = None
+    external: Optional[bool] = None
+    ready: Optional[bool] = None
+    mount: Optional[str] = None
 
 
 class DataAssetSortBy(StrEnum):
@@ -183,12 +189,6 @@ class DataAssetSortBy(StrEnum):
     Size = "size"
 
 
-class DataAssetOwnership(StrEnum):
-    Private = "private"
-    Shared = "shared"
-    Created = "created"
-
-
 class DataAssetSearchOrigin(StrEnum):
     Internal = "internal"
     External = "external"
@@ -197,16 +197,17 @@ class DataAssetSearchOrigin(StrEnum):
 @dataclass_json
 @dataclass(frozen=True)
 class DataAssetSearchParams:
-    limit: int
-    offset: int
-    archived: bool
-    favorite: bool
     query: Optional[str] = None
+    next_token: Optional[str] = None
+    offset: Optional[int] = None
+    limit: Optional[int] = None
     sort_field: Optional[DataAssetSortBy] = None
     sort_order: Optional[SortOrder] = None
     type: Optional[DataAssetType] = None
-    ownership: Optional[DataAssetOwnership] = None
+    ownership: Optional[Ownership] = None
     origin: Optional[DataAssetSearchOrigin] = None
+    favorite: Optional[bool] = None
+    archived: Optional[bool] = None
     filters: Optional[list[SearchFilter]] = None
 
 
@@ -215,6 +216,22 @@ class DataAssetSearchParams:
 class DataAssetSearchResults:
     has_more: bool
     results: list[DataAsset]
+    next_token: Optional[str] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class ContainedDataAsset:
+    id: Optional[str] = None
+    mount: Optional[str] = None
+    size: Optional[int] = None
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class TransferDataParams:
+    target: Target
+    force: Optional[bool] = None
 
 
 @dataclass
@@ -291,3 +308,41 @@ class DataAssets:
         res = self.client.post("data_assets/search", json=search_params.to_dict())
 
         return DataAssetSearchResults.from_dict(res.json())
+
+    def search_data_assets_iterator(self, search_params: DataAssetSearchParams) -> Iterator[DataAsset]:
+        params = search_params.to_dict()
+        while True:
+            response = self.search_data_assets(
+                search_params=DataAssetSearchParams(**params)
+            )
+
+            for result in response.results:
+                yield result
+
+            if not response.has_more:
+                return
+
+            params["next_token"] = response.next_token
+
+    def list_data_asset_files(self, data_asset_id: str, path: str = "") -> Folder:
+        data = {
+            "path": path,
+        }
+
+        res = self.client.post(f"data_assets/{data_asset_id}/files", json=data)
+
+        return Folder.from_dict(res.json())
+
+    def get_data_asset_file_download_url(self, data_asset_id: str, path: str) -> DownloadFileURL:
+        res = self.client.get(
+            f"data_assets/{data_asset_id}/files/download_url",
+            params={"path": path},
+        )
+
+        return DownloadFileURL.from_dict(res.json())
+
+    def transfer_data_asset(self, data_asset_id: str, transfer_params: TransferDataParams):
+        self.client.post(
+            f"data_assets/{data_asset_id}/transfer",
+            json=transfer_params.to_dict()
+        )

codeocean-0.3.1/src/codeocean/folder.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from dataclasses_json import dataclass_json
+from dataclasses import dataclass
+from typing import Optional
+
+
+@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