aignostics 0.2.73__tar.gz → 0.2.83__tar.gz

{aignostics-0.2.73 → aignostics-0.2.83}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aignostics
-Version: 0.2.73
+Version: 0.2.83
 Summary: 🔬 Python SDK providing access to the Aignostics Platform. Includes Aignostics Launchpad (Desktop Application), Aignostics CLI (Command-Line Interface), example notebooks, and Aignostics Client Library.
 Project-URL: Homepage, https://aignostics.readthedocs.io/en/latest/
 Project-URL: Documentation, https://aignostics.readthedocs.io/en/latest/

{aignostics-0.2.73 → aignostics-0.2.83}/examples/notebook.py

@@ -2,7 +2,7 @@
 # requires-python = ">=3.13"
 # dependencies = [
 #     "marimo",
-#     "aignostics==0.2.73",
+#     "aignostics==0.2.83",
 # ]
 # ///
 

{aignostics-0.2.73 → aignostics-0.2.83}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "aignostics"
-version = "0.2.73"
+version = "0.2.83"
 description = "🔬 Python SDK providing access to the Aignostics Platform. Includes Aignostics Launchpad (Desktop Application), Aignostics CLI (Command-Line Interface), example notebooks, and Aignostics Client Library."
 readme = "README.md"
 authors = [
@@ -354,7 +354,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.2.73"
+current_version = "0.2.83"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{aignostics-0.2.73 → aignostics-0.2.83}/src/aignostics/platform/__init__.py

@@ -1,9 +1,13 @@
-"""
-This module provides the main client interface for interacting with Aignostics services.
+"""This module provides the low-level client interface for interacting with the API of the Aignostics Platform.
+
+The primary class in this module is the `Client` class, serving as the entry point
+for authenticated API operations. Login and token management are handled
+automatically.
+
+Further operations are encapsulated in the `Service` class, which provides methods
+for manual login, logout and getting information about the authenticated user.
 
-It offers functionality for authentication, data management, and API operations.
-The primary class in this module is the `Client` class, which serves as the entry point
-for all interactions with the Aignostics platform.
+Higher level abstractions are provided in the application module.
 """
 
 from aignx.codegen.exceptions import ApiException, NotFoundException

{aignostics-0.2.73 → aignostics-0.2.83}/src/aignostics/platform/_utils.py

@@ -26,6 +26,7 @@ from aignx.codegen.models import OutputArtifactResultReadResponse as OutputArtif
 from tqdm.auto import tqdm
 
 EIGHT_MB = 8_388_608
+SIGNED_DOWNLOAD_URL_EXPIRES_SECONDS_DEFAULT = 6 * 60 * 60  # 6 hours
 
 
 def mime_type_to_file_ending(mime_type: str) -> str:
@@ -71,7 +72,6 @@ def get_mime_type_for_artifact(artifact: OutputArtifactData | InputArtifactData
     return str(metadata.get("media_type", metadata.get("mime_type", "application/octet-stream")))
 
 
-# TODO(Andreas,Helmut): discuss
 def download_file(signed_url: str, file_path: str, verify_checksum: str) -> None:
     """Downloads a file from a signed URL and verifies its integrity.
 
@@ -102,11 +102,12 @@ def download_file(signed_url: str, file_path: str, verify_checksum: str) -> None
         raise ValueError(msg)
 
 
-def generate_signed_url(url: str) -> str:
+def generate_signed_url(url: str, expires_seconds: int = SIGNED_DOWNLOAD_URL_EXPIRES_SECONDS_DEFAULT) -> str:
     """Generates a signed URL for a Google Cloud Storage object.
 
     Args:
         url (str): The fully qualified bucket URL (e.g. gs://bucket/path/to/object).
+        expires_seconds (int): The number of seconds the signed URL should be valid for.
 
     Returns:
         str: A signed URL that can be used to download the object.
@@ -131,7 +132,10 @@ def generate_signed_url(url: str) -> str:
         msg = f"Blob does not exist: {url}"
         raise ValueError(msg)
 
-    return t.cast("str", blob.generate_signed_url(expiration=datetime.timedelta(hours=1), method="GET", version="v4"))
+    return t.cast(
+        "str",
+        blob.generate_signed_url(expiration=datetime.timedelta(seconds=expires_seconds), method="GET", version="v4"),
+    )
 
 
 def calculate_file_crc32c(file: Path) -> str:

{aignostics-0.2.73 → aignostics-0.2.83}/src/aignostics/platform/resources/runs.py

@@ -128,13 +128,16 @@ class ApplicationRun:
             application_run_id=self.application_run_id,
         )
 
-    def download_to_folder(self, download_base: Path | str) -> None:
+    def download_to_folder(
+        self, download_base: Path | str, checksum_attribute_key: str = "checksum_base64_crc32c"
+    ) -> None:
         """Downloads all result artifacts to a folder.
 
         Monitors run progress and downloads results as they become available.
 
         Args:
             download_base (Path | str): Base directory to download results to.
+            checksum_attribute_key (str): The key used to validate the checksum of the output artifacts.
 
         Raises:
             ValueError: If the provided path is not a directory.
@@ -152,7 +155,7 @@ class ApplicationRun:
         while application_run_status == ApplicationRunStatus.RUNNING:
             for item in self.results():
                 if item.status == ItemStatus.SUCCEEDED:
-                    self.ensure_artifacts_downloaded(application_run_dir, item)
+                    self.ensure_artifacts_downloaded(application_run_dir, item, checksum_attribute_key)
             sleep(5)
             application_run_status = self.details().status
             print(self)
@@ -161,12 +164,14 @@ class ApplicationRun:
         for item in self.results():
             match item.status:
                 case ItemStatus.SUCCEEDED:
-                    self.ensure_artifacts_downloaded(application_run_dir, item)
+                    self.ensure_artifacts_downloaded(application_run_dir, item, checksum_attribute_key)
                 case ItemStatus.ERROR_SYSTEM | ItemStatus.ERROR_USER:
                     print(f"{item.reference} failed with {item.status.value}: {item.error}")
 
     @staticmethod
-    def ensure_artifacts_downloaded(base_folder: Path, item: ItemResultReadResponse) -> None:
+    def ensure_artifacts_downloaded(
+        base_folder: Path, item: ItemResultReadResponse, checksum_attribute_key: str = "checksum_base64_crc32c"
+    ) -> None:
         """Ensures all artifacts for an item are downloaded.
 
         Downloads missing or partially downloaded artifacts and verifies their integrity.
@@ -174,6 +179,7 @@ class ApplicationRun:
         Args:
             base_folder (Path): Base directory to download artifacts to.
             item (ItemResultReadResponse): The item result containing the artifacts to download.
+            checksum_attribute_key (str): The key used to validate the checksum of the output artifacts.
 
         Raises:
             ValueError: If checksums don't match.
@@ -187,7 +193,7 @@ class ApplicationRun:
                 item_dir.mkdir(exist_ok=True, parents=True)
                 file_ending = mime_type_to_file_ending(get_mime_type_for_artifact(artifact))
                 file_path = item_dir / f"{artifact.name}{file_ending}"
-                checksum = artifact.metadata["checksum_crc32c"]
+                checksum = artifact.metadata[checksum_attribute_key]
 
                 if file_path.exists():
                     file_checksum = calculate_file_crc32c(file_path)

{aignostics-0.2.73 → aignostics-0.2.83}/src/aignostics/platform/_service.py

@@ -213,20 +213,6 @@ class Service(BaseService):
             },
         )
 
-    @staticmethod
-    def logout() -> bool:
-        """Logout if authenticated.
-
-        Deletes the cached authentication token if existing.
-
-        Returns:
-            bool: True if successfully logged out, False if not logged in.
-        """
-        logger.debug("Logging out...")
-        rtn = remove_cached_token()
-        logger.debug("Logout successful: %s", rtn)
-        return rtn
-
     @staticmethod
     def login(relogin: bool = False) -> bool:
         """Login.
@@ -247,6 +233,20 @@ class Service(BaseService):
             logger.exception(message)
             return False
 
+    @staticmethod
+    def logout() -> bool:
+        """Logout if authenticated.
+
+        Deletes the cached authentication token if existing.
+
+        Returns:
+            bool: True if successfully logged out, False if not logged in.
+        """
+        logger.debug("Logging out...")
+        rtn = remove_cached_token()
+        logger.debug("Logout successful: %s", rtn)
+        return rtn
+
     @staticmethod
     def get_user_info(relogin: bool = False) -> UserInfo | None:
         """Get user information from authentication token.