automizor 0.4.11__py3-none-any.whl → 0.4.13__py3-none-any.whl

automizor/__init__.py

@@ -1 +1 @@
-version = "0.4.11"
+version = "0.4.13"

automizor/action/__init__.py

@@ -0,0 +1,38 @@
+import json
+from typing import Optional
+
+from automizor.utils import JSON
+
+from ._action import Action
+
+
+def configure(api_token: str):
+    """
+    Configures the Action instance with the provided API token.
+    """
+    Action.configure(api_token)
+
+
+def run(
+    name: str,
+    workspace: str,
+    data: Optional[JSON] = None,
+) -> JSON:
+    """
+    Runs an action using the specified action and workspace name.
+
+    Parameters:
+        name: The name of the action.
+        workspace: The workspace name to which the action belongs.
+        data: Optional action payload data.
+    """
+    payload = json.dumps(data or {}).encode("utf-8")
+
+    action = Action.get_instance()
+    return action.run(name, workspace, payload)
+
+
+__all__ = [
+    "configure",
+    "run",
+]

automizor/action/_action.py

@@ -0,0 +1,91 @@
+from typing import Optional
+
+import requests
+
+from automizor.exceptions import AutomizorError
+from automizor.utils import JSON, get_api_config, get_headers
+
+
+class Action:
+    """
+    The `Action` class is designed to interact with the `Automizor Platform` to run
+    action based on specified action name and for a workspaces.
+
+    This class uses environment variables for configuration, particularly to retrieve the
+    API host and API token, which are essential for authenticating requests to the
+    `Automizor Action API`. These variables are typically configured by the `Automizor Agent`.
+
+    Required environment variable:
+    - ``AUTOMIZOR_AGENT_TOKEN``: The token used for authenticating API requests.
+
+    Example usage:
+
+    .. code-block:: python
+
+        from automizor import action
+
+        # Run an action by name
+        action.run("action_name", "workspace_name")
+        action.run("action_name", "workspace_name", {"name": "John Doe"})
+    """
+
+    _instance = None
+
+    def __init__(self, api_token: Optional[str] = None):
+        self.url, self.token = get_api_config(api_token)
+        self.headers = get_headers(self.token)
+
+    @classmethod
+    def configure(cls, api_token: Optional[str] = None):
+        cls._instance = cls(api_token)
+
+    @classmethod
+    def get_instance(cls):
+        if cls._instance is None:
+            cls.configure()
+        return cls._instance
+
+    def run(
+        self,
+        name: str,
+        workspace: str,
+        payload: Optional[bytes],
+    ) -> JSON:
+        """
+        Runs an action using the specified action and workspace name.
+
+        Parameters:
+            name: The name of the action.
+            workspace: The workspace name to which the action belongs.
+            payload: Optional json payload in bytes.
+        """
+        return self._execute_action(name, workspace, payload)
+
+    def _execute_action(
+        self,
+        name: str,
+        workspace: str,
+        payload: Optional[bytes],
+    ) -> JSON:
+        """
+        Executes an action by action and workspace name.
+
+        Parameters:
+            name: The name of the action.
+            workspace: The workspace name to which the action belongs.
+            payload: Optional json payload in bytes.
+
+        Raises:
+            AutomizorError: If there is an error executing the action.
+        """
+        url = f"https://{self.url}/api/v2/action/{name}/execute?workspace={workspace}"
+        try:
+            response = requests.put(url, headers=self.headers, data=payload, timeout=10)
+            response.raise_for_status()
+            return response.json()
+        except requests.HTTPError as exc:
+            raise AutomizorError.from_response(
+                exc.response, "Failed to execute action"
+            ) from exc
+        except Exception as exc:
+            raise AutomizorError(f"Failed to execute action: {exc}") from exc

automizor/storage/_storage.py

@@ -33,19 +33,19 @@ class Storage:
         asset_names = storage.list_assets()
 
         # To delete an asset
-        storage.delete_asset("AssetName")
+        storage.delete_asset("asset_name")
 
         # Save an asset
-        storage.set_bytes("AssetName", b"Hello, World!")
-        storage.set_file("AssetName", "/path/to/file")
-        storage.set_json("AssetName", {"key": "value"})
-        storage.set_text("AssetName", "Hello, World!")
+        storage.set_bytes("asset_name", b"Hello, World!")
+        storage.set_file("asset_name", "/path/to/file")
+        storage.set_json("asset_name", {"key": "value"})
+        storage.set_text("asset_name", "Hello, World!")
 
         # Get an asset
-        bytes_data = storage.get_bytes("AssetName")
-        file_path = storage.get_file("AssetName", "/path/to/save/file")
-        json_data = storage.get_json("AssetName")
-        text_data = storage.get_text("AssetName")
+        bytes_data = storage.get_bytes("asset_name")
+        file_path = storage.get_file("asset_name", "/path/to/save/file")
+        json_data = storage.get_json("asset_name")
+        text_data = storage.get_text("asset_name")
     """
 
     _instance = None

automizor/vault/_vault.py

@@ -30,15 +30,15 @@ class Vault:
         from automizor import vault
 
         # Create a new secret
-        vault.create_secret(name="MySecret", value={"username": "admin", "password": "*****"})
+        vault.create_secret("my_secret", {"username": "admin", "password": "*****"})
 
         # Retrieve a secret by its name
-        secret = vault.get_secret("MySecret")
+        secret = vault.get_secret("my_secret")
         print(secret.get("username"))  # Output: "admin"
         print(secret.get("password"))  # Output: "*****"
 
         # Update a existing secret
-        secret = vault.get_secret("MySecret")
+        secret = vault.get_secret("my_secret")
         secret.update({"username": "user"})
         vault.set_secret(secret)
     """

automizor/workflow/__init__.py

@@ -28,7 +28,7 @@ def start_by_name(
         business_key: An optional business identifier.
         data: Optional initial instance data.
     """
-    payload = json.dumps(data).encode("utf-8")
+    payload = json.dumps(data or {}).encode("utf-8")
 
     workflow = Workflow.get_instance()
     workflow.start_by_name(process_model, workspace, business_key, payload)

automizor/workflow/_workflow.py

@@ -26,9 +26,9 @@ class Workflow:
         from automizor import workflow
 
         # Start a workflow instance by name
-        workflow.start_by_name("ModelName", "WorkspaceName")
-        workflow.start_by_name("ModelName", "WorkspaceName", "BusinessKey")
-        workflow.start_by_name("ModelName", "WorkspaceName", "BusinessKey", {"initial": "data"})
+        workflow.start_by_name("model_name", "workspace_name")
+        workflow.start_by_name("model_name", "workspace_name", "BusinessKey")
+        workflow.start_by_name("model_name", "workspace_name", "BusinessKey", {"initial": "data"})
     """
 
     _instance = None

{automizor-0.4.11.dist-info → automizor-0.4.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: automizor
-Version: 0.4.11
+Version: 0.4.13
 Summary: Python Automizor framework
 Home-page: https://github.com/automizor/automizor-python
 Author: Christian Fischer

automizor-0.4.13.dist-info/RECORD

@@ -0,0 +1,24 @@
+automizor/__init__.py,sha256=WRkFcZ9CwsiCl4SzZtaRPZi39RXgDOUfpS45qNm-KHo,19
+automizor/exceptions.py,sha256=P5imySIOtG3ZIk2kh41Yod4RnlgTj7Vf0P3M-RuxQJs,1382
+automizor/utils.py,sha256=UDYuSERa3IrS_1NreBTNBYf6j25ga2AiwRdq0c3kfvM,965
+automizor/action/__init__.py,sha256=nZinP2WYc8Da3rxE10Ul0V31GbEFXRgCYXtBOQ-0LwQ,767
+automizor/action/_action.py,sha256=Izouw7POKb-FatejTtHQ4EV16hwBu-7uGkzlqNi82VM,2897
+automizor/datastore/__init__.py,sha256=_rAdRfKnTa4SuSLl9GkAYziBPPLsy6yGfS0HprgokOk,2418
+automizor/datastore/_container.py,sha256=rHRkSWaRgy2rk6Qy-7ADFKvuET_COZ2i9VD7gvRDnlM,745
+automizor/datastore/_datastore.py,sha256=Tv0vRjIyeUfVy3V8pcZVN1dX7q7v8JbJ9L3SCIxX8aM,3396
+automizor/job/__init__.py,sha256=pDqSfR4lAyJNCi-fpG6byUPidHz8sntBs0bB2lJFVAY,1118
+automizor/job/_job.py,sha256=XJX9Q7GeOErb7U9Wb01Wv1twIlBqNnJePb0Epc8NdTs,5440
+automizor/log/__init__.py,sha256=gEr2SuwN1FgX1NMnbphjg8_gfSic9L15H3WC868A-TQ,2104
+automizor/log/_log.py,sha256=P9jAFXVANs5bAGH6-S0pzuSbRKEcX8VlQ_3uu690awE,2948
+automizor/storage/__init__.py,sha256=vCez0LucHQeRZDfX5xZulxf06i3ezVyFl4vL3-EYXXU,4160
+automizor/storage/_storage.py,sha256=x5gPxGkzQe21wDDnCLtmVWU0g9JeklPu9iIYVlPDRnk,11381
+automizor/vault/__init__.py,sha256=21Ag2zQk7x27Bh0yt_kSO2MkgT3eafbdlKe0NuQEqr8,1796
+automizor/vault/_container.py,sha256=-2y7kASigoIVAebuQBk-0R_sI4gfmvjsMLuMg_tR1xA,1945
+automizor/vault/_vault.py,sha256=pXS1Qcltjh48n9R0NX4q7PSpXT_XFjifRy9Hu4aQnUQ,5104
+automizor/workflow/__init__.py,sha256=J1K_ogAvbeREPbAmVxsAI1SOVHi_5DXnO9JuEKOMdt8,958
+automizor/workflow/_workflow.py,sha256=XhcDNBmORdqErj25sO1yb2koKObAFXVkgXrV7xx3EtI,3567
+automizor-0.4.13.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+automizor-0.4.13.dist-info/METADATA,sha256=uNxV7jylzE0xrRauW-vEdpmt7Yzn2zfesnXGXoqhpAs,669
+automizor-0.4.13.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+automizor-0.4.13.dist-info/top_level.txt,sha256=gScDy4I3tP6BMYAsTAlBXrxVh3E00zV0UioxwXJOI3Y,10
+automizor-0.4.13.dist-info/RECORD,,

{automizor-0.4.11.dist-info → automizor-0.4.13.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

automizor-0.4.11.dist-info/RECORD

@@ -1,22 +0,0 @@
-automizor/__init__.py,sha256=BgTmI_pMMS3dXctT_oRAuEr_Pn2I3qHQCFooYZOzQ1Q,19
-automizor/exceptions.py,sha256=P5imySIOtG3ZIk2kh41Yod4RnlgTj7Vf0P3M-RuxQJs,1382
-automizor/datastore/__init__.py,sha256=_rAdRfKnTa4SuSLl9GkAYziBPPLsy6yGfS0HprgokOk,2418
-automizor/datastore/_container.py,sha256=rHRkSWaRgy2rk6Qy-7ADFKvuET_COZ2i9VD7gvRDnlM,745
-automizor/datastore/_datastore.py,sha256=Tv0vRjIyeUfVy3V8pcZVN1dX7q7v8JbJ9L3SCIxX8aM,3396
-automizor/job/__init__.py,sha256=pDqSfR4lAyJNCi-fpG6byUPidHz8sntBs0bB2lJFVAY,1118
-automizor/job/_job.py,sha256=XJX9Q7GeOErb7U9Wb01Wv1twIlBqNnJePb0Epc8NdTs,5440
-automizor/log/__init__.py,sha256=gEr2SuwN1FgX1NMnbphjg8_gfSic9L15H3WC868A-TQ,2104
-automizor/log/_log.py,sha256=P9jAFXVANs5bAGH6-S0pzuSbRKEcX8VlQ_3uu690awE,2948
-automizor/storage/__init__.py,sha256=vCez0LucHQeRZDfX5xZulxf06i3ezVyFl4vL3-EYXXU,4160
-automizor/storage/_storage.py,sha256=VPIahpIjCBU7pT-2qvleWcYOMWoffR_x3XUk6nGzUmI,11372
-automizor/utils/__init__.py,sha256=UDYuSERa3IrS_1NreBTNBYf6j25ga2AiwRdq0c3kfvM,965
-automizor/vault/__init__.py,sha256=21Ag2zQk7x27Bh0yt_kSO2MkgT3eafbdlKe0NuQEqr8,1796
-automizor/vault/_container.py,sha256=-2y7kASigoIVAebuQBk-0R_sI4gfmvjsMLuMg_tR1xA,1945
-automizor/vault/_vault.py,sha256=n_ZgzSOdG0nTFnO8J3D69fgmcsRPRwmSDd5fvn2ZkUI,5112
-automizor/workflow/__init__.py,sha256=rfaqZojz35cEPN4WnqlvG_G9xzMDUDZIfwib17AQLQw,952
-automizor/workflow/_workflow.py,sha256=l4kb-eMdBpewa0inmseQMREorImjY829dDLA3DzCC7c,3561
-automizor-0.4.11.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-automizor-0.4.11.dist-info/METADATA,sha256=WKjbnfWNrOW_QZ_mrVdD0baRkmhZM9uTB0MnGBPwYcQ,669
-automizor-0.4.11.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-automizor-0.4.11.dist-info/top_level.txt,sha256=gScDy4I3tP6BMYAsTAlBXrxVh3E00zV0UioxwXJOI3Y,10
-automizor-0.4.11.dist-info/RECORD,,