dcipher 0.3.1__tar.gz → 0.3.3__tar.gz

{dcipher-0.3.1 → dcipher-0.3.3}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: dcipher
-Version: 0.3.1
+Version: 0.3.3
 Summary: The official Python client library for the Dcipher Workflows API
-Home-page: https://github.com/kairosfuture/dcipher-workflows-api-python
 License: MIT
 Author: Dcipher Analytics AB
 Author-email: dev@dcipheranalytics.com
@@ -20,17 +19,14 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Dist: httpx (>=0.23.0,<1)
 Requires-Dist: requests (>=2.28.2,<3.0.0)
 Requires-Dist: tenacity (>=8.2.3,<9.0.0)
+Project-URL: Homepage, https://github.com/kairosfuture/dcipher-workflows-api-python
 Project-URL: Repository, https://github.com/kairosfuture/dcipher-workflows-api-python
 Description-Content-Type: text/markdown
 

{dcipher-0.3.1 → dcipher-0.3.3}/dcipher/async_client.py

@@ -19,10 +19,13 @@ logger = setup_logger()
 
 class AsyncDcipher(Dcipher):
 
-    async def run_flow(self,
-                       flow_id: str,
-                       params: Dict[str, Any],
-                       save_path: Optional[str]):
+    async def run_flow(
+            self,
+            flow_id: str,
+            params: Dict[str, Any],
+            save_path: Optional[str] = None,
+            wait_until_completion: bool = False,
+    ) -> Dict[str, str]:
 
         request_params = self._prepare_request_params(
             flow_id=flow_id, params=params)
@@ -47,6 +50,14 @@ class AsyncDcipher(Dcipher):
         running_task_id = response["taskId"]
         logger.debug(f"Running taskId: {running_task_id}")
 
+        result = {
+            "task_id": running_task_id,
+            "signed_response_url": response_url,
+        }
+
+        if not wait_until_completion:
+            return result
+
         await asyncio.sleep(3)
 
         @retry(wait=wait_random_exponential(min=1, max=15),
@@ -72,8 +83,9 @@ class AsyncDcipher(Dcipher):
             message = status_response.get("message", "")
 
             if status == "SUCCEEDED":
-                logger.debug("Workflow has SUCCEEDED. Saving results")
-                self._save_result(url=response_url, save_path=save_path)
+                logger.debug("Workflow has SUCCEEDED.")
+                if save_path is not None:
+                    self._save_result(url=response_url, save_path=save_path)
                 break
 
             if status == "FAILED":
@@ -82,3 +94,5 @@ class AsyncDcipher(Dcipher):
 
             logger.debug(f"Status is {status}. Waiting for 3 more seconds")
             await asyncio.sleep(3)
+
+        return result

{dcipher-0.3.1 → dcipher-0.3.3}/dcipher/client.py

@@ -32,6 +32,8 @@ logger = setup_logger()
 
 class Dcipher:
 
+    BASE_URL = "https://api.dcipheranalytics.com"
+
     def __init__(self, api_key: Optional[str], max_retries: int = 100):
         self.api_key = api_key or os.environ.get("DCIPHER_API_KEY")
         if not self.api_key:
@@ -45,9 +47,8 @@ class Dcipher:
             "Authorization": f"Api-Key {self.api_key}",
             "Content-Type": "application/json",
         }
-        endpoint_url_template = "https://api.dcipheranalytics.com/flows/{}/run"
+        endpoint_url = f"{self.BASE_URL}/flows/{flow_id}/run"
 
-        endpoint_url = endpoint_url_template.format(flow_id)
         body = {
             "pipelineParams": params,
         }
@@ -62,18 +63,20 @@ class Dcipher:
             "Authorization": f"Api-Key {self.api_key}",
             "Content-Type": "application/json",
         }
-        status_endpoint_url_template = "https://api.dcipheranalytics.com/flows/{}/status"  # noqa
-        status_endpoint_url = status_endpoint_url_template.format(flow_id)
+        status_endpoint_url = f"{self.BASE_URL}/flows/{flow_id}/status"  # noqa
         url = f"{status_endpoint_url}?taskId={task_id}"
         return {
             "url": url,
             "headers": headers,
         }
 
-    def run_flow(self,
-                 flow_id: str,
-                 params: Dict[str, Any],
-                 save_path: Optional[str]):
+    def run_flow(
+            self,
+            flow_id: str,
+            params: Dict[str, Any],
+            save_path: Optional[str] = None,
+            wait_until_completion: bool = False,
+    ) -> Dict[str, str]:
 
         request_params = self._prepare_request_params(
             flow_id=flow_id, params=params)
@@ -97,6 +100,14 @@ class Dcipher:
         running_task_id = response["taskId"]
         logger.debug(f"Running taskId: {running_task_id}")
 
+        result = {
+            "task_id": running_task_id,
+            "signed_response_url": response_url,
+        }
+
+        if not wait_until_completion:
+            return result
+
         sleep(5)
 
         @retry(wait=wait_random_exponential(min=1, max=15),
@@ -120,8 +131,9 @@ class Dcipher:
             message = status_response.get("message", "")
 
             if status == "SUCCEEDED":
-                logger.debug("Workflow has SUCCEEDED. Saving results")
-                self._save_result(url=response_url, save_path=save_path)
+                logger.debug("Workflow has SUCCEEDED.")
+                if save_path is not None:
+                    self._save_result(url=response_url, save_path=save_path)
                 break
 
             if status == "FAILED":
@@ -131,6 +143,8 @@ class Dcipher:
             logger.debug(f"Status is {status}. Waiting for 3 more seconds")
             sleep(3)
 
+        return result
+
     def _save_result(self, url: str, save_path: str):
         # Send a GET request to the URL
         response = requests.get(url)

{dcipher-0.3.1 → dcipher-0.3.3}/dcipher/constants.py

@@ -1,8 +1,12 @@
+import json
+
 from httpx import NetworkError, TimeoutException
 from requests.exceptions import ConnectionError, Timeout
 
 from .exceptions import ConflictError, InternalServerError, RateLimitError
 
+# json.JSONDecodeError covers response.json() failures (requests + httpx).
 RETRIABLE_EXCEPTIONS = (ConnectionError, Timeout,
                         ConflictError, RateLimitError,
-                        InternalServerError, TimeoutException, NetworkError)
+                        InternalServerError, TimeoutException, NetworkError,
+                        json.JSONDecodeError)

{dcipher-0.3.1 → dcipher-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dcipher"
-version = "0.3.1"
+version = "0.3.3"
 license = "MIT"
 description = "The official Python client library for the Dcipher Workflows API"
 authors = ["Dcipher Analytics AB <dev@dcipheranalytics.com>"]