clerk-sdk 0.1.9__py3-none-any.whl → 0.2.1__py3-none-any.whl

clerk/models/remote_device.py

@@ -0,0 +1,7 @@
+from pydantic import BaseModel
+
+
+class RemoteDevice(BaseModel):
+    id: str
+    name: str
+    wss_token: str

clerk/utils/logger.py

@@ -0,0 +1,124 @@
+import inspect
+import os
+import logging
+import sys
+
+if sys.platform == "win32":
+    base_path = os.path.join(os.getcwd(), "data", "artifacts")
+else:
+    base_path = "/app/data/artifacts"
+
+os.makedirs(base_path, exist_ok=True)
+
+
+def debug(message: str):
+    """
+    Logs a debug message.
+
+    This function logs a debug message by calling the _log function with "DEBUG" as the level.
+
+    Args:
+        module (str): The name of the module or component that generated the log message.
+        message (str): The log message to be logged.
+    """
+    _log("DEBUG", message)
+
+
+def info(message: str):
+    """
+    Logs an info message.
+
+    This function logs an info message by calling the _log function with "INFO" as the level.
+
+    Args:
+        module (str): The name of the module or component that generated the log message.
+        message (str): The log message to be logged.
+    """
+    _log("INFO", message)
+
+
+def warning(message: str):
+    """
+    Logs a warning message.
+
+    This function logs a warning message by calling the _log function with "WARNING" as the level.
+
+    Args:
+        module (str): The name of the module or component that generated the log message.
+        message (str): The log message to be logged.
+    """
+    _log("WARNING", message)
+
+
+def error(message: str):
+    """
+    Logs an error message.
+
+    This function logs an error message by calling the _log function with "ERROR" as the level.
+
+    Args:
+        module (str): The name of the module or component that generated the log message.
+        message (str): The log message to be logged.
+    """
+    _log("ERROR", message)
+
+
+def _log(level: str, message: str):
+    """
+    Log a message to a file in the artifacts folder using the Python logging module.
+
+    Args:
+        level (str): The log level of the message (e.g., "INFO", "DEBUG", "WARNING", "ERROR", "AUDIT").
+        module (str): The name of the module or component that generated the log message.
+        message (str): The log message to be logged.
+
+    Returns:
+        None
+
+    Example Usage:
+        _log_to_console("INFO", "module_name", "This is an info message")
+
+    """
+    # Get run_id from environment variable or default to "unknown"
+    run_id = os.getenv("_RUN_ID", "unknown")
+
+    # Create the base path for artifacts
+    logs_path = os.path.join(base_path, run_id)
+    os.makedirs(logs_path, exist_ok=True)
+    # Define the log file path
+    log_file_path = os.path.join(logs_path, "logs.txt")
+
+    # Get the calling file (two levels up the stack)
+    frame = inspect.stack()[2]
+    module = os.path.basename(frame.filename)
+
+    # Configure the logger
+    logger = logging.getLogger(module)
+    if not logger.handlers:
+        fh = logging.FileHandler(log_file_path)
+        format = "%(asctime)s - %(name)s - %(levelname)s: - %(message)s"
+        formatter = logging.Formatter(format)
+        fh.setFormatter(formatter)
+        logger.addHandler(fh)
+        # → console handler  (same formatter)
+        sh = logging.StreamHandler(sys.stdout)
+        sh.setFormatter(formatter)
+        logger.addHandler(sh)
+
+    logger.setLevel(logging.DEBUG)
+    logger.propagate = False  # keep root logger from printing duplicates
+
+    # Log the message based on the level
+    if level.lower() == "info":
+        logger.info(message)
+    elif level.lower() == "audit":
+        logger.info("AUDIT: " + message)
+    elif level.lower() == "debug":
+        logger.debug(message)
+    elif level.lower() == "warning":
+        logger.warning(message)
+    elif level.lower() == "error":
+        logger.error(message)
+
+    # Remove handlers to avoid duplicate logs
+    logger.handlers.clear()

clerk/utils/save_artifact.py

@@ -0,0 +1,37 @@
+import os
+from typing import Optional
+from clerk.utils import logger
+
+
+def save_artifact(
+    filename: str, file_bytes: bytes, subfolder: Optional[str] = None
+) -> str:
+    """
+    Save an artifact to a specified path.
+
+    Args:
+        artifact: The artifact to save.
+        filename (str): The name of the file to save.
+        file_bytes (bytes): The bytes of the file to save.
+        subfolder (str): The subfolder where the artifact will be saved. Defaults to "artifacts".
+    Returns:
+        str: The path to the saved artifact.
+    """
+
+    # get the run ID from environment variable or default to "unknown"
+    run_id = os.getenv("_RUN_ID", "unknown")
+
+    # create the base path for artifacts
+    base_path = os.path.join(os.getcwd(), "data", "artifacts", run_id)
+    if subfolder:
+        base_path = os.path.join(base_path, subfolder)
+
+    os.makedirs(base_path, exist_ok=True)
+
+    # save the file
+    file_path = os.path.join(base_path, filename)
+    with open(file_path, "wb") as f:
+        f.write(file_bytes)
+
+    logger.debug(f"Artifact successfully saved at: {file_path}")
+    return file_path

{clerk_sdk-0.1.9.dist-info → clerk_sdk-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.1.9
+Version: 0.2.1
 Summary: Library for interacting with Clerk
 Home-page: https://github.com/F-ONE-Group/clerk_pypi
 Author: F-ONE Group
@@ -14,6 +14,15 @@ License-File: LICENSE
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: backoff<3.0.0,>=2.0.0
 Requires-Dist: requests<3.0.0,>=2.32.3
+Provides-Extra: all
+Requires-Dist: pydantic<3.0.0,>=2.0.0; extra == "all"
+Requires-Dist: backoff<3.0.0,>=2.0.0; extra == "all"
+Requires-Dist: requests<3.0.0,>=2.32.3; extra == "all"
+Requires-Dist: networkx<4.0.0,>=3.5.0; extra == "all"
+Requires-Dist: websockets>=15.0.1; extra == "all"
+Provides-Extra: gui-automation
+Requires-Dist: networkx<4.0.0,>=3.5.0; extra == "gui-automation"
+Requires-Dist: websockets>=15.0.1; extra == "gui-automation"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -21,6 +30,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license-file
+Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

clerk_sdk-0.2.1.dist-info/RECORD

@@ -0,0 +1,49 @@
+clerk/__init__.py,sha256=LWpbImG7352mUJYC1tRm_zsn5rnt4sFl5ldoq5f0dlo,26
+clerk/base.py,sha256=Ayb2zCQr8fqKZM_Qh3nVxVJOQkkYt-eD5VtpPXd1TLs,2669
+clerk/client.py,sha256=6nWWWjGB7a6FNUWsZRM-IoBb_mshRi6g5KX8meMiJ2E,576
+clerk/decorator/__init__.py,sha256=4VCGOFNq7pA7iJS410V_R9eWfjxP7mwxwa4thwaUTf8,39
+clerk/decorator/models.py,sha256=JWFOJuUh3F40iOL0aoNgUC9GRHU3Fcq3GOjSXA7Gwng,394
+clerk/decorator/task_decorator.py,sha256=srb8AC3tNj1RWC4iNkkwkUuG33B8TtxfTpOm1Oi373Y,2169
+clerk/gui_automation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clerk/gui_automation/client.py,sha256=LJFHdWreH0pZnRUZJ6jd4Xp3kYJjOjNLEUfHD0ly2Y0,4405
+clerk/gui_automation/action_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clerk/gui_automation/action_model/model.py,sha256=sbTySgOq4Xv_r2p7q_ji1bGCHgRS1HXC9Z39thwCQ9c,3829
+clerk/gui_automation/action_model/utils.py,sha256=xzFxgN-bTK6HKGS7J-esQZ-ePj_yG72T-2ZVhcWvKjw,798
+clerk/gui_automation/client_actor/__init__.py,sha256=SVuL6-oo1Xc0oJkjMKrO6mJwpPGjrCLKhDV6r2Abtf8,66
+clerk/gui_automation/client_actor/client_actor.py,sha256=Me3NHc0nMA7Y5CUcnE0ZHT1P7dQRGR6duCAKwn0Tg6g,5081
+clerk/gui_automation/client_actor/exception.py,sha256=zdnImHZ88yf52Xq3aMHivEU3aJg-r2c-r8x8XZnI3ic,407
+clerk/gui_automation/client_actor/model.py,sha256=wVpFCi1w2kh4kAV8oNx489vf_SLUQnqhc02rFD5NIJA,6335
+clerk/gui_automation/decorators/__init__.py,sha256=OCgXStEumscgT-RyVy5OKS7ml1w9y-lEnjCVnxuRnQs,43
+clerk/gui_automation/decorators/gui_automation.py,sha256=efB38zIcHsDubfnRgc_o1MgYEJAH7Sfv9oqKB7toZW4,4690
+clerk/gui_automation/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clerk/gui_automation/exceptions/agent_manager.py,sha256=KFWFWQ7X_8Z9XG__SMzb1jKI3yNoVTPJAXzW5O-fSXc,101
+clerk/gui_automation/exceptions/websocket.py,sha256=-MdwSwlf1hbnu55aDgk3L1znkTZ6xJS6po5VpEGD9ck,117
+clerk/gui_automation/exceptions/modality/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clerk/gui_automation/exceptions/modality/exc.py,sha256=P-dMuCTyVZYD3pbGpCf_1SYEgaETn13c51pmfbsXr5k,1436
+clerk/gui_automation/ui_actions/__init__.py,sha256=-EDQ5375HXrvG3sfFY7zOPC405YcBL6xXRACm2p-YyI,23
+clerk/gui_automation/ui_actions/actions.py,sha256=hhxl5VMDNSXdqm2L0tZqs6IhJHVXtlSVSdwsiz2BbDI,27449
+clerk/gui_automation/ui_actions/base.py,sha256=4CjOkMZNLt8W0tLO91tOkz8CCea0m2IRBIOpWNMOZUA,7230
+clerk/gui_automation/ui_actions/support.py,sha256=BS9QReyP_F9-oGPt0fuy5BD9kC9-E5mOE05Zk0M1Hzw,2176
+clerk/gui_automation/ui_state_inspector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clerk/gui_automation/ui_state_inspector/gui_vision.py,sha256=lRnF3IMLViOB-UE447A4kc8BO7NKqqLV1NZKRswRKWg,7707
+clerk/gui_automation/ui_state_inspector/models.py,sha256=uuzYhE9is4Z-TmsVMA1mwf0mQGs_PDLqdSZKbe8dHSs,5691
+clerk/gui_automation/ui_state_machine/__init__.py,sha256=bTPZsPJkDLCwP2mdtBj4fU7C7ekOh0b-VPRKFEV3bPo,301
+clerk/gui_automation/ui_state_machine/ai_recovery.py,sha256=3_Gu_RPxta4eXmXWH3WA31c15sJL-dk1m1H2bOFV7so,3772
+clerk/gui_automation/ui_state_machine/decorators.py,sha256=gBOpIusjsXlA7FEiszDCFKTS6vXx3LBNMz_SQJNkMWg,2134
+clerk/gui_automation/ui_state_machine/exceptions.py,sha256=9KWg20dnCssMdMu632E0nP5vkndgYNI4cDCDW-vMkQA,1436
+clerk/gui_automation/ui_state_machine/models.py,sha256=1fpNYPsff0dyLg1wNJl-xQyMYvy4cSDy4OLxa0ej-0U,1395
+clerk/gui_automation/ui_state_machine/state_machine.py,sha256=6WJQ5NsI9hOqN-VM0lYf_mv-xOQd0UjolGXJ0M58L1I,35230
+clerk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clerk/models/document.py,sha256=Bbt3YSvGcOrJJjJBYjbDGXpZIaQAYdq_-uIr2urwy5s,525
+clerk/models/document_statuses.py,sha256=ytTQhgACs2m22qz51_7Ti0IxzbVyl-fl7uF7CnDEyLA,279
+clerk/models/file.py,sha256=7n6bV6ukRA-uh7MFxUx_TEMNpVAdNe5O0nKIeneCQhg,459
+clerk/models/remote_device.py,sha256=2jijS-9WWq7y6xIbAaDaPnzZo3-tjp2-dCQvNKP8YSU,109
+clerk/models/response_model.py,sha256=R62daUN1YVOwgnrh_epvFRsQcOwT7R4u97l73egvm-c,232
+clerk/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clerk/utils/logger.py,sha256=_jYOSEc1WCsY9DvU8cIWUPmz41QNjpHTEZ7WrUnmFPA,3650
+clerk/utils/save_artifact.py,sha256=Lwl3l3QqKnSFLFpfEEa-dJ-dV9OxvCU3ADkuYZ18U-Q,1117
+clerk_sdk-0.2.1.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
+clerk_sdk-0.2.1.dist-info/METADATA,sha256=QEgrEZmgLaFSscyy0ob9Sr5Y4npmMXFbxF-kPxsk8lE,3508
+clerk_sdk-0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+clerk_sdk-0.2.1.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
+clerk_sdk-0.2.1.dist-info/RECORD,,

clerk_sdk-0.1.9.dist-info/RECORD

@@ -1,15 +0,0 @@
-clerk/__init__.py,sha256=LWpbImG7352mUJYC1tRm_zsn5rnt4sFl5ldoq5f0dlo,26
-clerk/client.py,sha256=UEbs5AhnBs6JWstLzT-TPHZ-yxyBwTFDLemv-yh25K4,3386
-clerk/decorator/__init__.py,sha256=4VCGOFNq7pA7iJS410V_R9eWfjxP7mwxwa4thwaUTf8,39
-clerk/decorator/models.py,sha256=FKs7oCq50hmvbzYWuscvqlL7boPYzMKv0Vg3tznmwao,361
-clerk/decorator/task_decorator.py,sha256=ns7eYcv835HoeRIJtB79HC6gMUUfboxY3lsIn5JakqI,2159
-clerk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/models/document.py,sha256=Bbt3YSvGcOrJJjJBYjbDGXpZIaQAYdq_-uIr2urwy5s,525
-clerk/models/document_statuses.py,sha256=ytTQhgACs2m22qz51_7Ti0IxzbVyl-fl7uF7CnDEyLA,279
-clerk/models/file.py,sha256=7n6bV6ukRA-uh7MFxUx_TEMNpVAdNe5O0nKIeneCQhg,459
-clerk/models/response_model.py,sha256=R62daUN1YVOwgnrh_epvFRsQcOwT7R4u97l73egvm-c,232
-clerk_sdk-0.1.9.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
-clerk_sdk-0.1.9.dist-info/METADATA,sha256=npxd_MCKjeQxbI9lMlgAfYi1QIVF8ewaWO-c6uTxFMY,3041
-clerk_sdk-0.1.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-clerk_sdk-0.1.9.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
-clerk_sdk-0.1.9.dist-info/RECORD,,