WIP: Dapi for TAPIS v3

Author: kks32

.github/workflows/build-test.yml

@@ -6,8 +6,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9"]
-        poetry-version: ["1.6.1"]
+        python-version: ["3.13"]
+        poetry-version: ["2.1.2"]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -23,5 +23,4 @@ jobs:
         run: poetry install
       - name: Lint with black
         run: poetry run black --check .
-      - name: Run the automated tests
-        run: poetry run pytest -v
+  

dapi/__init__.py

@@ -1,19 +1,31 @@
 """
 Dapi - A Python wrapper for interacting with DesignSafe resources via the Tapis API.
 """
-# Import the renamed client class
 from .client import DSClient
-from .exceptions import DapiException, FileOperationError, JobSubmissionError, JobMonitorError
-# Import JobDefinition here too for easier access like dapi.JobDefinition
-from .jobs import JobDefinition
 
-__version__ = "1.1.0" # Example version
+# Import exceptions from the exceptions module
+# Make sure ALL exceptions you want to expose are listed here
+from .exceptions import (
+    DapiException,
+    AuthenticationError,
+    FileOperationError,
+    AppDiscoveryError,
+    JobSubmissionError,
+    JobMonitorError,
+)
 
+
+__version__ = "1.0.0"
+
+# Define what gets imported with 'from dapi import *'
+# Also helps linters and clarifies the public API
 __all__ = [
-    "DSClient", # Export the renamed class
-    "JobDefinition", # Export JobDefinition
+    "DSClient",
+    # List ALL exported exceptions here
     "DapiException",
+    "AuthenticationError",
     "FileOperationError",
+    "AppDiscoveryError",
     "JobSubmissionError",
     "JobMonitorError",
-]
+]

dapi/apps.py

@@ -3,6 +3,7 @@
 from typing import List, Any, Optional
 from .exceptions import AppDiscoveryError
 
+
 def find_apps(
     t: Tapis, search_term: str, list_type: str = "ALL", verbose: bool = True
 ) -> List[Tapis]:
@@ -24,24 +25,34 @@ def find_apps(
     try:
         # Use id.like for partial matching, ensure search term is handled
         search_query = f"(id.like.*{search_term}*)" if search_term else None
-        results = t.apps.getApps(search=search_query, listType=list_type, select="id,version,owner") # Select fewer fields for speed
+        results = t.apps.getApps(
+            search=search_query, listType=list_type, select="id,version,owner"
+        )  # Select fewer fields for speed
 
         if verbose:
             if not results:
-                print(f"No apps found matching '{search_term}' with listType '{list_type}'")
+                print(
+                    f"No apps found matching '{search_term}' with listType '{list_type}'"
+                )
             else:
                 print(f"\nFound {len(results)} matching apps:")
                 for app in results:
                     print(f"- {app.id} (Version: {app.version}, Owner: {app.owner})")
                 print()
         return results
     except BaseTapyException as e:
-        raise AppDiscoveryError(f"Failed to search for apps matching '{search_term}': {e}") from e
+        raise AppDiscoveryError(
+            f"Failed to search for apps matching '{search_term}': {e}"
+        ) from e
     except Exception as e:
-        raise AppDiscoveryError(f"An unexpected error occurred while searching for apps: {e}") from e
+        raise AppDiscoveryError(
+            f"An unexpected error occurred while searching for apps: {e}"
+        ) from e
 
 
-def get_app_details(t: Tapis, app_id: str, app_version: Optional[str] = None, verbose: bool = True) -> Optional[Tapis]:
+def get_app_details(
+    t: Tapis, app_id: str, app_version: Optional[str] = None, verbose: bool = True
+) -> Optional[Tapis]:
     """
     Get detailed information for a specific app ID and version (or latest).
 
@@ -68,23 +79,31 @@ def get_app_details(t: Tapis, app_id: str, app_version: Optional[str] = None, ve
             print(f"  ID: {app_info.id}")
             print(f"  Version: {app_info.version}")
             print(f"  Owner: {app_info.owner}")
-            if hasattr(app_info, 'jobAttributes') and hasattr(app_info.jobAttributes, 'execSystemId'):
-                 print(f"  Execution System: {app_info.jobAttributes.execSystemId}")
+            if hasattr(app_info, "jobAttributes") and hasattr(
+                app_info.jobAttributes, "execSystemId"
+            ):
+                print(f"  Execution System: {app_info.jobAttributes.execSystemId}")
             else:
-                 print("  Execution System: Not specified in jobAttributes")
+                print("  Execution System: Not specified in jobAttributes")
             print(f"  Description: {app_info.description}")
         return app_info
     except BaseTapyException as e:
         # Check for 404 specifically
-        if hasattr(e, 'response') and e.response and e.response.status_code == 404:
-             print(f"App '{app_id}' (Version: {app_version or 'latest'}) not found.")
-             # Optionally, try searching for similar apps
-             # print("\nAttempting to find similar apps:")
-             # find_apps(t, app_id, verbose=True)
-             return None
+        if hasattr(e, "response") and e.response and e.response.status_code == 404:
+            print(f"App '{app_id}' (Version: {app_version or 'latest'}) not found.")
+            # Optionally, try searching for similar apps
+            # print("\nAttempting to find similar apps:")
+            # find_apps(t, app_id, verbose=True)
+            return None
         else:
-             print(f"Error getting app info for '{app_id}' (Version: {app_version or 'latest'}): {e}")
-             raise AppDiscoveryError(f"Failed to get details for app '{app_id}': {e}") from e
+            print(
+                f"Error getting app info for '{app_id}' (Version: {app_version or 'latest'}): {e}"
+            )
+            raise AppDiscoveryError(
+                f"Failed to get details for app '{app_id}': {e}"
+            ) from e
     except Exception as e:
         print(f"An unexpected error occurred getting app info for '{app_id}': {e}")
-        raise AppDiscoveryError(f"Unexpected error getting details for app '{app_id}': {e}") from e
+        raise AppDiscoveryError(
+            f"Unexpected error getting details for app '{app_id}': {e}"
+        ) from e

dapi/auth.py

@@ -5,10 +5,13 @@
 from dotenv import load_dotenv
 from .exceptions import AuthenticationError
 
-def init(base_url: str = "https://designsafe.tapis.io",
-         username: str = None,
-         password: str = None,
-         env_file: str = None) -> Tapis:
+
+def init(
+    base_url: str = "https://designsafe.tapis.io",
+    username: str = None,
+    password: str = None,
+    env_file: str = None,
+) -> Tapis:
     """
     Initialize and authenticate a Tapis client for DesignSafe.
 
@@ -49,20 +52,21 @@ def init(base_url: str = "https://designsafe.tapis.io",
         try:
             final_password = getpass("Enter DesignSafe Password: ")
         except (EOFError, KeyboardInterrupt):
-             raise AuthenticationError("Password input cancelled.")
-        except Exception: # Fallback for non-terminal environments
-             final_password = input("Enter DesignSafe Password: ")
-
+            raise AuthenticationError("Password input cancelled.")
+        except Exception:  # Fallback for non-terminal environments
+            final_password = input("Enter DesignSafe Password: ")
 
     if not final_username or not final_password:
         raise AuthenticationError("Username and password are required.")
 
     # Initialize Tapis object
     try:
-        t = Tapis(base_url=base_url,
-                  username=final_username,
-                  password=final_password,
-                  download_latest_specs=False) # Avoid slow spec downloads by default
+        t = Tapis(
+            base_url=base_url,
+            username=final_username,
+            password=final_password,
+            download_latest_specs=False,
+        )  # Avoid slow spec downloads by default
 
         # Attempt to get tokens to verify credentials
         t.get_tokens()
@@ -74,4 +78,6 @@ def init(base_url: str = "https://designsafe.tapis.io",
         raise AuthenticationError(f"Tapis authentication failed: {e}") from e
     except Exception as e:
         # Catch other potential errors
-        raise AuthenticationError(f"An unexpected error occurred during authentication: {e}") from e
+        raise AuthenticationError(
+            f"An unexpected error occurred during authentication: {e}"
+        ) from e