codeocean 0.3.0__tar.gz → 0.3.2__tar.gz

{codeocean-0.3.0 → codeocean-0.3.2}/CHANGELOG.md

@@ -1,6 +1,14 @@
 CHANGELOG
 =========
 
+## 0.3.2 (2025-02-21)
+- [#33](https://github.com/codeocean/codeocean-sdk-python/pull/33) feat: add iterator function for search capsule API
+
+## 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
@@ -9,6 +17,7 @@ CHANGELOG
 - [#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)
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codeocean
-Version: 0.3.0
+Version: 0.3.2
 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
@@ -41,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.3.0 → codeocean-0.3.2}/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.2/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.3.0 → codeocean-0.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "codeocean"
-version = "0.3.0"
+version = "0.3.2"
 authors = [
   { name="Code Ocean", email="dev@codeocean.com" },
 ]

{codeocean-0.3.0 → codeocean-0.3.2}/src/codeocean/capsule.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from dataclasses_json import dataclass_json
-from typing import Optional
+from typing import Optional, Iterator
 from requests_toolbelt.sessions import BaseUrlSession
 
 from codeocean.components import Ownership, SortOrder, SearchFilter
@@ -113,3 +113,18 @@ class Capsules:
         res = self.client.post("capsules/search", json=search_params.to_dict())
 
         return CapsuleSearchResults.from_dict(res.json())
+
+    def search_capsules_iterator(self, search_params: CapsuleSearchParams) -> Iterator[Capsules]:
+        params = search_params.to_dict()
+        while True:
+            response = self.search_capsules(
+                search_params=CapsuleSearchParams(**params)
+            )
+
+            for result in response.results:
+                yield result
+
+            if not response.has_more:
+                return
+
+            params["next_token"] = response.next_token

{codeocean-0.3.0 → codeocean-0.3.2}/src/codeocean/data_asset.py

@@ -53,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
@@ -97,10 +97,10 @@ class DataAsset:
 @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
 
 
@@ -175,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):