automizor 0.4.6__tar.gz → 0.4.8__tar.gz

{automizor-0.4.6/automizor.egg-info → automizor-0.4.8}/PKG-INFO

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

automizor-0.4.8/README.md

@@ -0,0 +1 @@
+# Automizor Python SDK

automizor-0.4.8/automizor/__init__.py

@@ -0,0 +1 @@
+version = "0.4.8"

automizor-0.4.8/automizor/datastore/__init__.py

@@ -0,0 +1,98 @@
+from ._container import DataStoreContainer
+from ._datastore import DataStore
+
+
+def configure(api_token: str):
+    """
+    Configures the DataStore instance with the provided API token.
+    """
+    DataStore.configure(api_token)
+
+
+def get_store(name: str) -> "DataStoreContainer":
+    """
+    Get a store container by name. The `DataStoreContainer` is a wrapper
+    around the data store that provides a get and set method to interact
+    with the data store.
+
+    Example usage:
+
+        .. code-block:: python
+
+            from automizor import datastore
+
+            # Get a data store countries
+            countries = datastore.get_store("countries")
+
+            # Initialize or update json store
+            countries.set([
+                {
+                    "name": "United States",
+                    "code": "US",
+                },
+                {
+                    "name": "Canada",
+                    "code": "CA",
+                },
+            ])
+
+            # Get values from json store
+            result = countries.get()
+
+            # Get a data store movies
+            movies = datastore.get_store("movies")
+
+            # Initialize or update kkv store
+            movies.set({
+                "US": {
+                    "action": {
+                        "Die Hard": 1988,
+                        "The Matrix": 1999
+                    }
+                }
+            })
+
+            # Get values from kkv store
+            result = movies.get("US")
+            result = movies.get("US", "action")
+
+            # Insert or update values
+            movies.set({
+                "US": {
+                    "action": {
+                        "Die Hard": 1988,
+                        "The Matrix": 1999,
+                        "John Wick": 2014
+                    },
+                    "comedy": {
+                        "The Hangover": 2009,
+                        "Superbad": 2007
+                    }
+                }
+            })
+
+            # Delete secondary key
+            movies.set({
+                "US": {
+                    "action": None
+                }
+            })
+
+            # Delete primary key
+            movies.set({
+                "US": None
+            })
+
+    """
+
+    datastore = DataStore.get_instance()
+    return DataStoreContainer(
+        datastore=datastore,
+        name=name,
+    )
+
+
+__all__ = [
+    "configure",
+    "get_store",
+]

automizor-0.4.8/automizor/datastore/_container.py

@@ -0,0 +1,28 @@
+from dataclasses import dataclass
+
+from automizor.utils import JSON
+
+
+@dataclass
+class DataStoreContainer:
+    """
+    The `DataStoreContainer` is a wrapper around the data store that
+    provides a get and set method to interact with the data store.
+
+    Attributes:
+        datastore: The data store.
+        name: The name of the data store.
+    """
+
+    from ._datastore import DataStore
+
+    datastore: DataStore
+    name: str
+
+    def get(self, primary_key=None, secondary_key=None):
+        """Get values from the datastore."""
+        return self.datastore.get_values(self.name, primary_key, secondary_key)
+
+    def set(self, values: JSON):
+        """Set values in the datastore."""
+        self.datastore.set_values(self.name, values)

{automizor-0.4.6 → automizor-0.4.8}/automizor/datastore/_datastore.py

@@ -1,33 +1,42 @@
-from typing import Dict, List, Union
-
 import requests
 
 from automizor.exceptions import AutomizorError
-from automizor.utils import get_api_config, get_headers
-
-JSON = Union[str, int, float, bool, None, Dict[str, "JSON"], List["JSON"]]
+from automizor.utils import JSON, get_api_config, get_headers
 
 
 class DataStore:
     """
-    `DataStore` is a class designed to interface with the `Automizor Platform` to manage and
-    manipulate data stored in various formats. It supports operations to retrieve and update
-    data using a unified API.
+    `DataStore` is a class designed to interface with the `Automizor Platform`
+    to manage and manipulate data stored in various formats. It supports
+    operations to retrieve and update data using a unified API.
 
-    The class initializes an HTTP session with the necessary headers for authentication, and
-    provides methods to retrieve values, and set values in the store.
+    The class initializes an HTTP session with the necessary headers for
+    authentication, and provides methods to retrieve values, and set values in
+    the store.
 
     Attributes:
         url (str): The base URL for the API endpoint.
         token (str): The authentication token for API access.
-        session (requests.Session): The HTTP session used for making API requests.
+        session (requests.Session): The HTTP session used to make API requests.
     """
 
-    def __init__(self):
-        self.url, self.token = get_api_config()
+    _instance = None
+
+    @classmethod
+    def configure(cls, api_token: str | None = None):
+        cls._instance = cls(api_token)
+
+    def __init__(self, api_token: str | None = None):
+        self.url, self.token = get_api_config(api_token)
         self.session = requests.Session()
         self.session.headers.update(get_headers(self.token))
 
+    @classmethod
+    def get_instance(cls):
+        if cls._instance is None:
+            cls.configure()
+        return cls._instance
+
     def get_values(
         self,
         name: str,
@@ -39,8 +48,8 @@ class DataStore:
 
         Parameters:
             name (str): The name of the data store.
-            primary_key (str, optional): The primary key for the values. Defaults to None.
-            secondary_key (str, optional): The secondary key for the values. Defaults to None.
+            primary_key (str, optional): The primary key for the values.
+            secondary_key (str, optional): The secondary key for the values.
 
         Returns:
             JSON: The values from the data store.
@@ -64,7 +73,7 @@ class DataStore:
         name: str,
         primary_key: str | None = None,
         secondary_key: str | None = None,
-    ) -> dict:
+    ) -> JSON:
         params = (
             {"primary_key": primary_key, "secondary_key": secondary_key}
             if primary_key or secondary_key

{automizor-0.4.6 → automizor-0.4.8}/automizor/job/__init__.py

@@ -1,13 +1,13 @@
-from functools import lru_cache
+from automizor.utils import JSON
 
-from ._job import JSON
+from ._job import Job
 
 
-@lru_cache
-def _get_job():
-    from ._job import Job
-
-    return Job()
+def configure(api_token: str):
+    """
+    Configures the Job instance with the provided API token.
+    """
+    Job.configure(api_token)
 
 
 def get_context() -> dict:
@@ -22,7 +22,7 @@ def get_context() -> dict:
         AutomizorJobError: If retrieving the job context fails.
     """
 
-    job = _get_job()
+    job = Job.get_instance()
     return job.get_context()
 
 
@@ -38,11 +38,12 @@ def set_result(name: str, value: JSON):
     Note: Errors during file operations will raise unhandled exceptions.
     """
 
-    job = _get_job()
+    job = Job.get_instance()
     return job.set_result(name, value)
 
 
 __all__ = [
+    "configure",
     "get_context",
     "set_result",
 ]

{automizor-0.4.6 → automizor-0.4.8}/automizor/job/_job.py

@@ -1,13 +1,10 @@
 import json
 import os
-from typing import Dict, List, Union
 
 import requests
 
 from automizor.exceptions import AutomizorError
-from automizor.utils import get_api_config, get_headers
-
-JSON = Union[str, int, float, bool, None, Dict[str, "JSON"], List["JSON"]]
+from automizor.utils import JSON, get_api_config, get_headers
 
 
 class Job:
@@ -49,14 +46,26 @@ class Job:
         job.set_result("result_name", {"key": "value"})
     """
 
-    def __init__(self):
+    _instance = None
+
+    @classmethod
+    def configure(cls, api_token: str | None = None):
+        cls._instance = cls(api_token)
+
+    def __init__(self, api_token: str | None = None):
         self._context_file = os.getenv("AUTOMIZOR_CONTEXT_FILE", None)
         self._job_id = os.getenv("AUTOMIZOR_JOB_ID", None)
 
-        self.url, self.token = get_api_config()
+        self.url, self.token = get_api_config(api_token)
         self.session = requests.Session()
         self.session.headers.update(get_headers(self.token))
 
+    @classmethod
+    def get_instance(cls):
+        if cls._instance is None:
+            cls.configure()
+        return cls._instance
+
     def get_context(self) -> dict:
         """
         Retrieves the context of the current job, which contains necessary information

{automizor-0.4.6 → automizor-0.4.8}/automizor/storage/__init__.py

@@ -1,17 +1,18 @@
 import json
 import mimetypes
-from functools import lru_cache
 from pathlib import Path
 from typing import List
 
-from ._storage import JSON
+from automizor.utils import JSON
 
+from ._storage import Storage
 
-@lru_cache
-def _get_storage():
-    from ._storage import Storage
 
-    return Storage()
+def configure(api_token: str):
+    """
+    Configures the Storage instance with the provided API token.
+    """
+    Storage.configure(api_token)
 
 
 def list_assets() -> List[str]:
@@ -22,7 +23,7 @@ def list_assets() -> List[str]:
         A list of all asset names.
     """
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     return storage.list_assets()
 
 
@@ -34,7 +35,7 @@ def delete_asset(name: str):
         name: The name identifier of the asset to delete.
     """
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     storage.delete_asset(name)
 
 
@@ -49,7 +50,7 @@ def get_bytes(name: str) -> bytes:
         The raw byte content of the asset.
     """
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     return storage.get_bytes(name)
 
 
@@ -65,7 +66,7 @@ def get_file(name: str, path: str) -> str:
         The path to the saved file, confirming the operation's success.
     """
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     return storage.get_file(name, path)
 
 
@@ -80,7 +81,7 @@ def get_json(name: str) -> JSON:
         The parsed JSON data, which can be a dict, list, or primitive data type.
     """
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     return storage.get_json(name)
 
 
@@ -95,7 +96,7 @@ def get_text(name: str) -> str:
         The content of the asset as a text string.
     """
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     return storage.get_text(name)
 
 
@@ -109,7 +110,7 @@ def set_bytes(name: str, data: bytes, content_type="application/octet-stream"):
         content_type: The MIME type of the asset.
     """
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     storage.set_bytes(name, data, content_type)
 
 
@@ -124,12 +125,12 @@ def set_file(name: str, path: str, content_type: str = None):
     """
 
     content = Path(path).read_bytes()
-    if content_type is None:
+    if not content_type:
         content_type, _ = mimetypes.guess_type(path)
         if content_type is None:
             content_type = "application/octet-stream"
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     storage.set_bytes(name, content, content_type)
 
 
@@ -146,7 +147,7 @@ def set_json(name: str, value: JSON, **kwargs):
     content = json.dumps(value, **kwargs).encode("utf-8")
     content_type = "application/json"
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     storage.set_bytes(name, content, content_type)
 
 
@@ -162,11 +163,12 @@ def set_text(name: str, text: str):
     content = text.encode("utf-8")
     content_type = "text/plain"
 
-    storage = _get_storage()
+    storage = Storage.get_instance()
     storage.set_bytes(name, content, content_type)
 
 
 __all__ = [
+    "configure",
     "list_assets",
     "delete_asset",
     "get_bytes",

{automizor-0.4.6 → automizor-0.4.8}/automizor/storage/_storage.py

@@ -1,11 +1,9 @@
-from typing import Dict, List, Union
+from typing import List
 
 import requests
 
 from automizor.exceptions import AutomizorError, NotFound
-from automizor.utils import get_api_config, get_headers
-
-JSON = Union[str, int, float, bool, None, Dict[str, "JSON"], List["JSON"]]
+from automizor.utils import JSON, get_api_config, get_headers
 
 
 class Storage:
@@ -50,11 +48,23 @@ class Storage:
         text_data = storage.get_text("AssetName")
     """
 
-    def __init__(self):
-        self.url, self.token = get_api_config()
+    _instance = None
+
+    @classmethod
+    def configure(cls, api_token: str | None = None):
+        cls._instance = cls(api_token)
+
+    def __init__(self, api_token: str | None = None):
+        self.url, self.token = get_api_config(api_token)
         self.session = requests.Session()
         self.session.headers.update(get_headers(self.token))
 
+    @classmethod
+    def get_instance(cls):
+        if cls._instance is None:
+            cls.configure()
+        return cls._instance
+
     def list_assets(self) -> List[str]:
         """
         Retrieves a list of all asset names.

automizor-0.4.8/automizor/utils/__init__.py

@@ -0,0 +1,34 @@
+import os
+import platform
+from typing import Dict, List, Union
+
+from automizor import version
+from automizor.exceptions import AutomizorError
+
+JSON = Union[str, int, float, bool, None, Dict[str, "JSON"], List["JSON"]]
+
+
+OS_SYSTEM, OS_RELEASE, _ = platform.system_alias(
+    platform.system(), platform.release(), platform.version()
+)
+
+
+def get_api_config(api_token: str | None = None) -> tuple[str, str]:
+    if api_token is None:
+        api_token = os.getenv("AUTOMIZOR_AGENT_TOKEN")
+
+        if not api_token:
+            raise AutomizorError("AUTOMIZOR_AGENT_TOKEN is not set.")
+
+    try:
+        token, url = api_token.strip().split("@")
+    except ValueError as exc:
+        raise AutomizorError("The API token is not in the correct format.") from exc
+    return url, token
+
+
+def get_headers(token: str) -> dict:
+    return {
+        "Authorization": f"Token {token}",
+        "User-Agent": f"Automizor/{version} {OS_SYSTEM}/{OS_RELEASE}",
+    }

{automizor-0.4.6 → automizor-0.4.8}/automizor/vault/__init__.py

@@ -1,14 +1,14 @@
-from functools import lru_cache
 from typing import Any, Dict
 
 from ._container import SecretContainer
+from ._vault import Vault
 
 
-@lru_cache
-def _get_vault():
-    from ._vault import Vault
-
-    return Vault()
+def configure(api_token: str):
+    """
+    Configures the Vault instance with the provided API token.
+    """
+    Vault.configure(api_token)
 
 
 def create_secret(
@@ -38,7 +38,7 @@ def create_secret(
         value=value,
     )
 
-    vault = _get_vault()
+    vault = Vault.get_instance()
     return vault.create_secret(secret)
 
 
@@ -56,7 +56,7 @@ def get_secret(name: str) -> SecretContainer:
         AutomizorVaultError: If retrieving the secret fails.
     """
 
-    vault = _get_vault()
+    vault = Vault.get_instance()
     return vault.get_secret(name)
 
 
@@ -74,12 +74,13 @@ def set_secret(secret: SecretContainer) -> SecretContainer:
         AutomizorVaultError: If updating the secret fails.
     """
 
-    vault = _get_vault()
+    vault = Vault.get_instance()
     return vault.set_secret(secret)
 
 
 __all__ = [
     "SecretContainer",
+    "configure",
     "create_secret",
     "get_secret",
     "set_secret",

{automizor-0.4.6 → automizor-0.4.8}/automizor/vault/_vault.py

@@ -42,11 +42,23 @@ class Vault:
         vault.set_secret(secret)
     """
 
-    def __init__(self):
-        self.url, self.token = get_api_config()
+    _instance = None
+
+    @classmethod
+    def configure(cls, api_token: str | None = None):
+        cls._instance = cls(api_token)
+
+    def __init__(self, api_token: str | None = None):
+        self.url, self.token = get_api_config(api_token)
         self.session = requests.Session()
         self.session.headers.update(get_headers(self.token))
 
+    @classmethod
+    def get_instance(cls):
+        if cls._instance is None:
+            cls.configure()
+        return cls._instance
+
     def create_secret(self, secret: SecretContainer) -> SecretContainer:
         """
         Creates a new secret. Stores the secret in the `Automizor API`.

{automizor-0.4.6 → automizor-0.4.8/automizor.egg-info}/PKG-INFO

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

{automizor-0.4.6 → automizor-0.4.8}/automizor.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ automizor.egg-info/dependency_links.txt
 automizor.egg-info/requires.txt
 automizor.egg-info/top_level.txt
 automizor/datastore/__init__.py
+automizor/datastore/_container.py
 automizor/datastore/_datastore.py
 automizor/job/__init__.py
 automizor/job/_job.py

automizor-0.4.6/README.md

@@ -1 +0,0 @@
-# Automizor Python automation framework

automizor-0.4.6/automizor/__init__.py

@@ -1 +0,0 @@
-version = "0.4.6"

automizor-0.4.6/automizor/datastore/__init__.py

@@ -1,107 +0,0 @@
-import sys
-import types
-from functools import lru_cache
-
-from ._datastore import JSON
-
-
-@lru_cache
-def _get_datastore():
-    from ._datastore import DataStore
-
-    return DataStore()
-
-
-class DataStoreProxy(types.ModuleType):
-    """
-    `DataStoreProxy` acts as a dynamic interface for interacting with various types of
-    data stores within the `Automizor Platform`. It provides a convenient way to access
-    and manipulate data stored in JSON and Key-Key-Value (KKV) formats.
-
-    This class leverages the `Automizor DataStore` module to fetch and update data,
-    utilizing a caching mechanism to enhance performance. The primary interaction is
-    through attribute access and assignment, making it simple to work with different
-    data structures.
-
-    Example usage:
-
-        .. code-block:: python
-
-            from automizor import datastore
-
-            # Initialize or update json store
-            datastore.countries = {
-                "US": {
-                    "name": "United States",
-                    "capital": "Washington, D.C.",
-                    "population": 331449281,
-                    "area": 9833520
-                },
-                "CA": {
-                    "name": "Canada",
-                    "capital": "Ottawa",
-                    "population": 38005238,
-                    "area": 9984670
-                }
-            }
-
-            # Get values from json store
-            countries = datastore.countries()
-
-            # Initialize or update kkv store
-            datastore.movies = {
-                "US": {
-                    "action": {
-                        "Die Hard": 1988,
-                        "The Matrix": 1999
-                    }
-                }
-            }
-
-            # Get values from kkv store
-            movies = datastore.movies("US")
-            movies_action = datastore.movies("US", "action")
-
-            # Insert or update values
-            datastore.movies = {
-                "US": {
-                    "action": {
-                        "Die Hard": 1988,
-                        "The Matrix": 1999,
-                        "John Wick": 2014
-                    },
-                    "comedy": {
-                        "The Hangover": 2009,
-                        "Superbad": 2007
-                    }
-                }
-            }
-
-            # Delete secondary key
-            datastore.movies = {
-                "US": {
-                    "action": None
-                }
-            }
-
-            # Delete primary key
-            datastore.movies = {
-                "US": None
-            }
-
-    """
-
-    def __getattr__(self, name):
-        datastore = _get_datastore()
-
-        def wrapper(primary_key=None, secondary_key=None):
-            return datastore.get_values(name, primary_key, secondary_key)
-
-        return wrapper
-
-    def __setattr__(self, name, values: JSON):
-        datastore = _get_datastore()
-        datastore.set_values(name, values)
-
-
-sys.modules[__name__] = DataStoreProxy(__name__)

automizor-0.4.6/automizor/utils/__init__.py

@@ -1,31 +0,0 @@
-import os
-import platform
-
-from automizor import version
-from automizor.exceptions import AutomizorError
-
-OS_SYSTEM, OS_RELEASE, _ = platform.system_alias(
-    platform.system(), platform.release(), platform.version()
-)
-
-
-def get_api_config() -> tuple[str, str]:
-    token_string = os.getenv("AUTOMIZOR_AGENT_TOKEN")
-
-    if not token_string:
-        raise AutomizorError("AUTOMIZOR_AGENT_TOKEN is not set.")
-
-    try:
-        token, url = token_string.strip().split("@")
-    except ValueError as exc:
-        raise AutomizorError(
-            "AUTOMIZOR_AGENT_TOKEN is not in the correct format."
-        ) from exc
-    return url, token
-
-
-def get_headers(token: str) -> dict:
-    return {
-        "Authorization": f"Token {token}",
-        "User-Agent": f"Automizor/{version} {OS_SYSTEM}/{OS_RELEASE}",
-    }