codeocean 0.10.0__tar.gz → 0.12.0__tar.gz

{codeocean-0.10.0 → codeocean-0.12.0}/CHANGELOG.md

@@ -1,8 +1,16 @@
 CHANGELOG
 =========
 
+## 0.12.0 (2025-10-20)
+- [#61](https://github.com/codeocean/codeocean-sdk-python/pull/61) feat: add search_pipelines method
+
+## 0.11.0 (2025-10-07)
+- [#55](https://github.com/codeocean/codeocean-sdk-python/pull/55) feat: Code Ocean version 4.0 functionality
+- **Minimum Code Ocean platform version updated to `4.0.0`.** 
+
 ## 0.10.0 (2025-09-01)
 - [#54](https://github.com/codeocean/codeocean-sdk-python/pull/54) feat: Code Ocean version 3.9 functionality
+- **Minimum Code Ocean platform version updated to `3.9.0`.** 
 
 ## 0.9.1 (2025-08-29)
 - [#56](https://github.com/codeocean/codeocean-sdk-python/pull/56) fix: update query description in search APIs

{codeocean-0.10.0 → codeocean-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codeocean
-Version: 0.10.0
+Version: 0.12.0
 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

{codeocean-0.10.0 → codeocean-0.12.0}/pyproject.toml

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

{codeocean-0.10.0 → codeocean-0.12.0}/src/codeocean/capsule.py

@@ -547,3 +547,24 @@ class Capsules:
                 return
 
             params["next_token"] = response.next_token
+
+    def search_pipelines(self, search_params: CapsuleSearchParams) -> CapsuleSearchResults:
+        """Search for pipelines with filtering, sorting, and pagination
+        options."""
+        res = self.client.post("pipelines/search", json=search_params.to_dict())
+
+        return CapsuleSearchResults.from_dict(res.json())
+
+    def search_pipelines_iterator(self, search_params: CapsuleSearchParams) -> Iterator[Capsule]:
+        """Iterate through all pipelines matching search criteria with automatic pagination."""
+        params = search_params.to_dict()
+        while True:
+            response = self.search_pipelines(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.10.0 → codeocean-0.12.0}/src/codeocean/client.py

@@ -37,7 +37,7 @@ class CodeOcean:
     agent_id: Optional[str] = None
 
     # Minimum server version required by this SDK
-    MIN_SERVER_VERSION = "3.9.0"
+    MIN_SERVER_VERSION = "4.0.0"
 
     def __post_init__(self):
         self.session = BaseUrlSession(base_url=f"{self.domain}/api/v1/")

{codeocean-0.10.0 → codeocean-0.12.0}/src/codeocean/computation.py

@@ -5,9 +5,10 @@ from dataclasses_json import dataclass_json
 from requests_toolbelt.sessions import BaseUrlSession
 from typing import Optional
 from time import sleep, time
+from warnings import warn
 
 from codeocean.enum import StrEnum
-from codeocean.folder import Folder, DownloadFileURL
+from codeocean.folder import FileURLs, Folder, DownloadFileURL
 
 
 class ComputationState(StrEnum):
@@ -332,7 +333,16 @@ class Computations:
         return Folder.from_dict(res.json())
 
     def get_result_file_download_url(self, computation_id: str, path: str) -> DownloadFileURL:
-        """Generate a download URL for a specific result file from a computation."""
+        """[DEPRECATED] Generate a download URL for a specific result file from a computation.
+
+        Deprecated: Use get_result_file_urls instead.
+        """
+        warn(
+            "get_result_file_download_url is deprecated and will be removed in a future release. "
+            "Use get_result_file_urls instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         res = self.client.get(
             f"computations/{computation_id}/results/download_url",
             params={"path": path},
@@ -340,6 +350,15 @@ class Computations:
 
         return DownloadFileURL.from_dict(res.json())
 
+    def get_result_file_urls(self, computation_id: str, path: str) -> FileURLs:
+        """Generate view and download URLs for a specific result file from a computation."""
+        res = self.client.get(
+            f"computations/{computation_id}/results/urls",
+            params={"path": path},
+        )
+
+        return FileURLs.from_dict(res.json())
+
     def delete_computation(self, computation_id: str):
         """Delete a computation and stop it if currently running."""
         self.client.delete(f"computations/{computation_id}")

{codeocean-0.10.0 → codeocean-0.12.0}/src/codeocean/data_asset.py

@@ -5,11 +5,12 @@ from dataclasses import dataclass, field
 from requests_toolbelt.sessions import BaseUrlSession
 from time import sleep, time
 from typing import Optional, Iterator
+from warnings import warn
 
 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
+from codeocean.folder import FileURLs, Folder, DownloadFileURL
 
 
 class DataAssetType(StrEnum):
@@ -849,7 +850,16 @@ class DataAssets:
         return Folder.from_dict(res.json())
 
     def get_data_asset_file_download_url(self, data_asset_id: str, path: str) -> DownloadFileURL:
-        """Generate a download URL for a specific file from an internal data asset."""
+        """(Deprecated) Generate a download URL for a specific file from an internal data asset.
+
+        Deprecated: Use get_data_asset_file_urls instead.
+        """
+        warn(
+            "get_data_asset_file_download_url is deprecated and will be removed in a future release. "
+            "Use get_data_asset_file_urls instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         res = self.client.get(
             f"data_assets/{data_asset_id}/files/download_url",
             params={"path": path},
@@ -857,6 +867,15 @@ class DataAssets:
 
         return DownloadFileURL.from_dict(res.json())
 
+    def get_data_asset_file_urls(self, data_asset_id: str, path: str) -> FileURLs:
+        """Generate view and download URLs for a specific file from an internal data asset."""
+        res = self.client.get(
+            f"data_assets/{data_asset_id}/files/urls",
+            params={"path": path},
+        )
+
+        return FileURLs.from_dict(res.json())
+
     def transfer_data_asset(self, data_asset_id: str, transfer_params: TransferDataParams):
         """
         Transfer a data asset's files to a different S3 storage location (Admin only).

{codeocean-0.10.0 → codeocean-0.12.0}/src/codeocean/folder.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from dataclasses_json import dataclass_json
 from dataclasses import dataclass, field
 from typing import Optional
+from warnings import warn
 
 
 @dataclass_json
@@ -53,3 +54,23 @@ class DownloadFileURL:
     url: str = field(
         metadata={"description": "Pre-signed URL for downloading the specified file"}
     )
+
+    def __post_init__(self):
+        warn(
+            "DownloadFileURL is deprecated and will be removed in a future release.",
+            DeprecationWarning,
+            stacklevel=2
+        )
+
+
+@dataclass_json
+@dataclass(frozen=True)
+class FileURLs:
+    """Represents a collection of file download URLs."""
+
+    download_url: str = field(
+        metadata={"description": "Signed URL for downloading the file"}
+    )
+    view_url: str = field(
+        metadata={"description": "Signed URL for viewing the file in the browser"}
+    )