automizor 0.3.1__py3-none-any.whl → 0.4.1__py3-none-any.whl

automizor/job.py

@@ -1,132 +0,0 @@
-import json
-import os
-from typing import Any, Dict, List, Union
-
-import requests
-
-JSONType = Union[str, int, float, bool, None, Dict[str, Any], List[Any]]
-
-
-class AutomizorJobError(RuntimeError):
-    """Exception raised for errors encountered while interacting with the Job."""
-
-
-class Job:
-    """
-    Represents a job in the `Automizor Platform`, managing the retrieval and storage of job
-    context and results.
-
-    This class provides functionality to interact with the `Automizor API` or local files to
-    obtain job context and persist job results.
-
-    For testing purposes, you may want to set the environment variables in your local environment.
-    The required variables are:
-
-    - ``AUTOMIZOR_API_HOST``: The host URL of the `Automizor API`
-    - ``AUTOMIZOR_API_TOKEN``: The token used for authenticating with the `Automizor API`
-    - ``AUTOMIZOR_JOB_ID``: The ID of the job from which to retrieve context
-
-    Additionally, you can specify a local context file; in this case, you don't need to set the
-    above environment variables:
-
-    - ``AUTOMIZOR_CONTEXT_FILE``: The path to a local file containing the job context.
-
-    Example of a local context file:
-
-    .. code-block:: json
-
-        {
-            "key": "value"
-        }
-
-    Example usage:
-
-    .. code-block:: python
-
-        from automizor.job import Job
-
-        job = Job()
-
-        def read_context():
-            context = job.get_job_context()
-            print(context["key"])  # Output: "value"
-
-        def save_result():
-            job.set_job_result("result_key", "result_value")
-
-    """
-
-    def __init__(self):
-        self._api_host = os.getenv("AUTOMIZOR_API_HOST")
-        self._api_token = os.getenv("AUTOMIZOR_API_TOKEN")
-        self._context_file = os.getenv("AUTOMIZOR_CONTEXT_FILE")
-        self._job_id = os.getenv("AUTOMIZOR_JOB_ID")
-
-    @property
-    def headers(self) -> dict:
-        """Headers for API requests, including Authorization and Content-Type."""
-        return {
-            "Authorization": f"Token {self._api_token}",
-            "Content-Type": "application/json",
-        }
-
-    def get_job_context(self) -> dict:
-        """
-        Retrieves the job's context from either a local file or via an API call, based on
-        the configuration.
-
-        If a local context file is specified (via `AUTOMIZOR_CONTEXT_FILE`), it reads the context
-        from the file. Otherwise, it fetches the context from the Automizor API using the job ID
-        and API credentials.
-
-        Returns:
-            A dictionary with the job's context.
-
-        Raises:
-            AutomizorJobError: If retrieving the job context fails.
-        """
-
-        if self._context_file:
-            return self._read_file_context()
-        return self._read_job_context()
-
-    def set_job_result(self, name: str, value: JSONType):
-        """
-        Saves a job result into a JSON file (`output/result.json`).
-
-        Updates the file with the new result, creating or overwriting the file as necessary.
-        If the file exists and contains data, it merges the new result with the existing data.
-
-        Parameters:
-            name (str): The key under which to store the result.
-            value (JSONType): The result value, must be JSON serializable.
-
-        Note: Errors during file operations will raise unhandled exceptions.
-        """
-
-        data = {}
-        file_path = "output/result.json"
-        try:
-            if os.path.exists(file_path):
-                with open(file_path, "r", encoding="utf-8") as file:
-                    data = json.load(file)
-        except json.JSONDecodeError:
-            pass
-
-        data[name] = value
-
-        with open(file_path, "w", encoding="utf-8") as file:
-            json.dump(data, file, ensure_ascii=False, indent=4)
-
-    def _read_file_context(self) -> dict:
-        with open(self._context_file, "r", encoding="utf-8") as file:
-            return json.load(file)
-
-    def _read_job_context(self) -> dict:
-        url = f"https://{self._api_host}/api/v1/rpa/job/{self._job_id}/"
-        try:
-            response = requests.get(url, headers=self.headers, timeout=10)
-            response.raise_for_status()
-            return response.json().get("context", {})
-        except Exception as exc:
-            raise AutomizorJobError(f"Failed to get job context: {exc}") from exc

automizor/storage/_exceptions.py

@@ -1,2 +0,0 @@
-class AutomizorStorageError(RuntimeError):
-    """Exception raised for errors encountered while interacting with the Storage."""

automizor/vault/_exceptions.py

@@ -1,2 +0,0 @@
-class AutomizorVaultError(RuntimeError):
-    """Exception raised for errors encountered while interacting with the Vault."""

automizor/vault/_secret.py

@@ -1,45 +0,0 @@
-from dataclasses import dataclass
-
-
-@dataclass
-class Secret:
-    """
-    Represents a secret, comprising a name and its associated values.
-
-    Attributes:
-        name: The name of the secret.
-        value: The secret's values, stored in a dictionary as key-value pairs.
-    """
-
-    name: str
-    value: dict
-
-    def get(self, key, default=None):
-        """Return the value for key if key is in the dictionary, else default."""
-        return self.value.get(key, default)
-
-    def items(self):
-        """secret.items() -> a set-like object providing a view on secret's items."""
-        return self.value.items()
-
-    def update(self, pairs: dict) -> None:
-        self.value.update(pairs)
-
-    def __getitem__(self, key):
-        return self.value[key]
-
-    def __setitem__(self, key, value):
-        self.value[key] = value
-
-    def __contains__(self, key):
-        return key in self.value
-
-    def __iter__(self):
-        return iter(self.value)
-
-    def __len__(self):
-        return len(self.value)
-
-    def __repr__(self):
-        keys = ", ".join(self.value.keys())
-        return f"Secret(name={self.name}, keys={keys})"

automizor/vault.py

@@ -1,190 +0,0 @@
-import json
-import os
-from dataclasses import asdict, dataclass
-
-import requests
-
-
-class AutomizorVaultError(RuntimeError):
-    """Exception raised for errors encountered while interacting with the Vault."""
-
-
-@dataclass
-class Secret:
-    """
-    Represents a secret, comprising a name and its associated values.
-
-    Attributes:
-        name (str): The name of the secret.
-        value (dict): The secret's values, stored in a dictionary as key-value pairs.
-    """
-
-    name: str
-    value: dict
-
-    def get(self, key, default=None):
-        """Return the value for key if key is in the dictionary, else default."""
-        return self.value.get(key, default)
-
-    def items(self):
-        """secret.items() -> a set-like object providing a view on secret's items."""
-        return self.value.items()
-
-    def update(self, pairs: dict) -> None:
-        self.value.update(pairs)
-
-    def __getitem__(self, key):
-        return self.value[key]
-
-    def __setitem__(self, key, value):
-        self.value[key] = value
-
-    def __contains__(self, key):
-        return key in self.value
-
-    def __iter__(self):
-        return iter(self.value)
-
-    def __len__(self):
-        return len(self.value)
-
-    def __repr__(self):
-        keys = ", ".join(self.value.keys())
-        return f"Secret(name={self.name}, keys={keys})"
-
-
-class Vault:
-    """
-    `Vault` is a library to manage secrets within an the `Automizor Platform`,
-    providing functionality to retrieve and update secrets. It supports interaction
-    with the `Vault API` (by default) or a local file for secret storage, determined
-    by environment variable configuration.
-
-    The Vault class uses environment variables to configure the API host, API token,
-    which are set by the `Automizor Agent`.
-
-    You may want to set the environment variables in your local environment for testing
-    purposes. The variables which must exist are:
-
-    - ``AUTOMIZOR_API_HOST``: The host URL of the `Automizor API`
-    - ``AUTOMIZOR_API_TOKEN``: The token used for authenticating with the `Automizor API`
-
-    In addition, you can set the following environment variable to use a local file for
-    secret storage:
-
-    - ``AUTOMIZOR_SECRET_FILE``: The path to a local file where secrets are stored.
-
-    Example of a local secret file:
-
-    .. code-block:: json
-
-        {
-            "my_secret_name": {
-                "key": "value"
-            }
-        }
-
-    Example usage:
-
-    .. code-block:: python
-
-        from automizor.vault import Vault
-
-        vault = Vault()
-
-        def read_secret():
-            secret = vault.get_secret("my_secret_name")
-            print(secret["key"])  # Output: "value"
-
-        def update_secret():
-            secret = vault.get_secret("my_secret_name")
-            secret["new_key"] = "new_value"
-            vault.set_secret(secret)
-
-    """
-
-    def __init__(self):
-        self._api_host = os.getenv("AUTOMIZOR_API_HOST")
-        self._api_token = os.getenv("AUTOMIZOR_API_TOKEN")
-        self._secret_file = os.getenv("AUTOMIZOR_SECRET_FILE")
-
-    @property
-    def headers(self) -> dict:
-        """Headers for API requests, including Authorization and Content-Type."""
-        return {
-            "Authorization": f"Token {self._api_token}",
-            "Content-Type": "application/json",
-        }
-
-    def get_secret(self, name) -> Secret:
-        """
-        Retrieves a secret by its name. Fetches from a local file or queries the
-        `Automizor API`, based on configuration.
-
-        Args:
-            name (str): The name of the secret to retrieve.
-
-        Returns:
-            Secret: The retrieved secret.
-
-        Raises:
-            AutomizorVaultError: If retrieving the secret fails.
-        """
-
-        if self._secret_file:
-            return self._read_file_secret(name)
-        return self._read_vault_secret(name)
-
-    def set_secret(self, secret: Secret) -> Secret:
-        """
-        Updates a secret. Writes to a local file or sends to the `Automizor API`,
-        based on configuration.
-
-        Args:
-            secret (Secret): The secret to update.
-
-        Returns:
-            Secret: The updated secret.
-
-        Raises:
-            AutomizorVaultError: If updating the secret fails.
-        """
-
-        if self._secret_file:
-            return self._write_file_secret(secret)
-        return self._write_vault_secret(secret)
-
-    def _read_file_secret(self, name: str) -> Secret:
-        with open(self._secret_file, "r", encoding="utf-8") as file:
-            secrets = json.load(file)
-            value = secrets.get(name, {})
-        return Secret(name=name, value=value)
-
-    def _read_vault_secret(self, name: str) -> Secret:
-        url = f"https://{self._api_host}/api/v1/vault/secret/{name}/"
-        try:
-            response = requests.get(url, headers=self.headers, timeout=10)
-            response.raise_for_status()
-            return Secret(**response.json())
-        except Exception as exc:
-            raise AutomizorVaultError(f"Failed to get secret: {exc}") from exc
-
-    def _write_file_secret(self, secret: Secret):
-        with open(self._secret_file, "r+", encoding="utf-8") as file:
-            secrets = json.load(file)
-            secrets[secret.name] = secret.value
-            file.seek(0)
-            file.write(json.dumps(secrets, indent=4))
-            file.truncate()
-        return secret
-
-    def _write_vault_secret(self, secret: Secret) -> Secret:
-        url = f"https://{self._api_host}/api/v1/vault/secret/{secret.name}/"
-        try:
-            response = requests.put(
-                url, headers=self.headers, timeout=10, json=asdict(secret)
-            )
-            response.raise_for_status()
-            return Secret(**response.json())
-        except Exception as exc:
-            raise AutomizorVaultError(f"Failed to set secret: {exc}") from exc

automizor-0.3.1.dist-info/RECORD

@@ -1,20 +0,0 @@
-automizor/__init__.py,sha256=sEAhGxRzEBE5t0VjAcJ-336II62pGIQ0eLrs42I-sGU,18
-automizor/job.py,sha256=L2NkM-BkvJpeO_SH0BMgternD9M83K_Yv_ANhf1k3FI,4354
-automizor/storage.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-automizor/vault.py,sha256=mluaCcJCMxu2g0iTBJ6ntoZATn8eotfZb4rdzWsBslU,5845
-automizor/job/__init__.py,sha256=g-n56j50AGPCE23Nm0QFZCrkCa-c_weqvPcEX3I1NQY,1087
-automizor/job/_exceptions.py,sha256=zngd7Vv4dkCfwmkigaHiyu5gKAgmcRHt095h55KlbDg,121
-automizor/job/_job.py,sha256=NkoNnJxmdkqdF-Qxm4taal-Go0COVFo57tZAaWM1ihI,5365
-automizor/storage/__init__.py,sha256=KuWO-Pb4FQXj68Ewv8QZR9XeKsROCR-wusdWf0osaLw,1674
-automizor/storage/_exceptions.py,sha256=LOtgshWg3gOFhDZlcMWhXLT_q11zpTBEA85NqKnSi4A,129
-automizor/storage/_storage.py,sha256=IwTw6PYYNwJtGI4ZfiqY0-SkgCoaYnykkP_hHVuy9IU,5777
-automizor/vault/__init__.py,sha256=Y3FsdG5cdksVO8nBzIPt8Wwxg8VkFtkpu-kn1xWxrGo,1140
-automizor/vault/_container.py,sha256=QgTZtBQrX8wZSEjJqTkn2_S-rwIRxukdBQYIRd7md_g,1904
-automizor/vault/_exceptions.py,sha256=Wblvmaj6F0pIiTAH7X3JuxqTprUA5tvuuRAs9YgbiBI,125
-automizor/vault/_secret.py,sha256=pks_3uvD1IhYirOaZ2cAOxX2r9vzvXqLa-aDzJysreE,1136
-automizor/vault/_vault.py,sha256=G1IryuPfXeMUMoAFmGgPibD70zn307KQLNcNitd3D1A,4825
-automizor-0.3.1.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-automizor-0.3.1.dist-info/METADATA,sha256=SkNNe2kHyA9aGX2275j7RFOy6GqKb9eN3WwQBT3sRpM,661
-automizor-0.3.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-automizor-0.3.1.dist-info/top_level.txt,sha256=gScDy4I3tP6BMYAsTAlBXrxVh3E00zV0UioxwXJOI3Y,10
-automizor-0.3.1.dist-info/RECORD,,