clerk-sdk 0.4.17__tar.gz → 0.5.0.dev0__tar.gz

clerk_sdk-0.5.0.dev0/.github/workflows/ci.yaml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    env:
+      __TEST: "true"  
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r ./clerk/gui_automation/requirements.txt
+          pip install build twine pytest
+
+      - name: Run tests
+        run: pytest
+
+      - name: Build package
+        run: python -m build

clerk_sdk-0.5.0.dev0/.github/workflows/pypi_publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    name: Build and Publish to PyPI
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+          
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: twine upload dist/*

clerk_sdk-0.5.0.dev0/.gitignore

@@ -0,0 +1,86 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+.venv.bak/
+venv.bak/
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+*.egg
+
+# PyPI upload tools
+*.log
+*.bak
+
+# Editor-specific files
+.vscode/
+.idea/
+*.swp
+*~
+
+# macOS
+.DS_Store
+
+# Windows
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+
+# Jupyter
+.ipynb_checkpoints/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# profiling
+.prof
+
+# dotenv
+.env
+.env.*
+
+# Wheel & tarball artifacts
+*.whl
+*.tar.gz
+*.zip
+
+# Python project metadata
+MANIFEST
+
+# Coverage
+.pytest_cache/
+
+data/*

{clerk_sdk-0.4.17/clerk_sdk.egg-info → clerk_sdk-0.5.0.dev0}/PKG-INFO

@@ -1,39 +1,26 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.4.17
+Version: 0.5.0.dev0
 Summary: Library for interacting with Clerk
-Home-page: https://github.com/F-ONE-Group/clerk_pypi
-Author: F-ONE Group
-Author-email: admin@f-one.group
-Classifier: Programming Language :: Python :: 3
+Project-URL: Homepage, https://github.com/F-ONE-Group/clerk_pypi
+Author-email: F-One <contact@f-one.group>
+License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: backoff<3.0.0,>=2.0.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: python-dotenv>=1.0.0
 Requires-Dist: requests<3.0.0,>=2.32.3
+Requires-Dist: rich>=14.2.0
 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"
+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
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
+Requires-Dist: networkx<4.0.0,>=3.5.0; extra == 'gui-automation'
+Requires-Dist: websockets>=15.0.1; extra == 'gui-automation'
+Description-Content-Type: text/markdown
 
 # Clerk Python SDK
 

{clerk_sdk-0.4.17 → clerk_sdk-0.5.0.dev0}/clerk/__init__.py

@@ -1,4 +1,4 @@
 from .client import Clerk
 
 
-__version__ = "0.4.17"
+__version__ = "0.5.0.dev0"

clerk_sdk-0.5.0.dev0/clerk/development/cli.py

@@ -0,0 +1,113 @@
+"""Clerk CLI - Unified command-line interface for Clerk development tools"""
+import os
+import sys
+import argparse
+from pathlib import Path
+from dotenv import load_dotenv
+
+
+def find_project_root() -> Path:
+    """Find the project root by looking for common markers"""
+    cwd = Path.cwd()
+
+    project_root_files = ["pyproject.toml", ".env"]
+
+    # Check current directory and parents
+    for path in [cwd] + list(cwd.parents):
+        for marker in project_root_files:
+            if (path / marker).exists():
+                return path
+
+    return cwd
+
+
+def main():
+    """Main CLI entry point with subcommands"""
+    # Find project root and load environment variables from there
+    project_root = find_project_root()
+    dotenv_path = project_root / ".env"
+    load_dotenv(dotenv_path)
+
+    parser = argparse.ArgumentParser(
+        prog="clerk",
+        description="Clerk development tools",
+        epilog="Run 'clerk <command> --help' for more information on a command."
+    )
+
+    subparsers = parser.add_subparsers(dest="command", help="Available commands")
+
+    # Init project subcommand
+    init_parser = subparsers.add_parser(
+        "init", help="Initialize a new Clerk custom code project"
+    )
+    init_parser.add_argument(
+        "--target-dir",
+        type=str,
+        default=None,
+        help="Target directory for the project (default: ./src)",
+    )
+
+    # GUI command group
+    gui_parser = subparsers.add_parser(
+        "gui",
+        help="GUI automation commands"
+    )
+    gui_subparsers = gui_parser.add_subparsers(dest="gui_command", help="GUI subcommands")
+    
+    # GUI connect subcommand
+    gui_connect_parser = gui_subparsers.add_parser(
+        "connect",
+        help="Start interactive GUI automation test session"
+    )
+
+    # Schema command group
+    schema_parser = subparsers.add_parser(
+        "schema",
+        help="Schema management commands"
+    )
+    schema_subparsers = schema_parser.add_subparsers(dest="schema_command", help="Schema subcommands")
+    
+    # Schema fetch subcommand
+    schema_fetch_parser = schema_subparsers.add_parser(
+        "fetch",
+        help="Fetch and generate Pydantic models from project schema"
+    )
+
+    args = parser.parse_args()
+
+    # Show help if no command specified
+    if not args.command:
+        parser.print_help()
+        sys.exit(1)
+
+    # Route to appropriate handler
+    if args.command == "init":
+        from clerk.development.init_project import main_with_args
+
+        main_with_args(gui_automation=None, target_dir=args.target_dir)
+
+    elif args.command == "gui":
+        if not hasattr(args, 'gui_command') or not args.gui_command:
+            gui_parser.print_help()
+            sys.exit(1)
+        
+        if args.gui_command == "connect":
+            from clerk.development.gui.test_session import main as gui_main
+            gui_main()
+
+    elif args.command == "schema":
+        if not hasattr(args, 'schema_command') or not args.schema_command:
+            schema_parser.print_help()
+            sys.exit(1)
+        
+        if args.schema_command == "fetch":
+            from clerk.development.schema.fetch_schema import main_with_args
+            project_id = os.getenv("PROJECT_ID")
+            if not project_id:
+                print("Error: PROJECT_ID environment variable not set.")
+                sys.exit(1)
+            main_with_args(project_id, project_root)
+
+
+if __name__ == "__main__":
+    main()

clerk_sdk-0.5.0.dev0/clerk/development/gui/test_session.py

@@ -0,0 +1,327 @@
+import sys
+from pathlib import Path
+import time
+from datetime import datetime
+import traceback
+import importlib
+from typing import Any
+
+from dotenv import load_dotenv
+from rich.console import Console
+from rich.panel import Panel
+from rich.text import Text
+
+from clerk.gui_automation.ui_actions.actions import (    
+    File, 
+    LeftClick,
+    RightClick,
+    DoubleClick,
+    PressKeys,
+    SendKeys,
+    WaitFor,
+    Scroll,
+    OpenApplication,
+    ForceCloseApplication,
+    SaveFiles,
+    DeleteFiles,
+    GetFile,
+    MaximizeWindow,
+    MinimizeWindow,
+    CloseWindow,
+    ActivateWindow,
+    GetText,
+    PasteText,
+    BaseAction
+)
+from clerk.gui_automation.decorators import gui_automation
+from clerk.decorator.models import ClerkCodePayload, Document
+from clerk.gui_automation.ui_state_machine.state_machine import ScreenPilot
+from clerk.gui_automation.ui_state_inspector.gui_vision import Vision, BaseState
+
+
+# Initialize rich console
+console = Console()
+
+# Store session state
+SESSION_FILE = Path(".test_session_active")
+ACTION_HISTORY = []
+VISION_CLIENT = Vision()
+
+
+def find_project_root() -> Path:
+    """Find the project root by looking for common markers"""
+    cwd = Path.cwd()
+
+    project_root_files = ["pyproject.toml"]
+
+    # Check current directory and parents
+    for path in [cwd] + list(cwd.parents):
+        for marker in project_root_files:
+            if (path / marker).exists():
+                return path
+
+    return cwd
+
+
+def reload_states() -> int:
+    """Reload states from conventional paths. Returns number of states loaded."""
+    project_root = find_project_root()
+
+    # Common module paths where states might be defined
+    # These are module paths (dot-separated), not file paths
+    state_module_paths = ["src.gui.states", "states"]
+
+    loaded_count = 0
+
+    # Add project root to sys.path if not already there
+    if str(project_root) not in sys.path:
+        sys.path.insert(0, str(project_root))
+
+    # Try to import/reload each module path
+    for module_path in state_module_paths:
+        try:
+            # Reload if already imported, otherwise import fresh
+            if module_path in sys.modules:
+                importlib.reload(sys.modules[module_path])
+            else:
+                importlib.import_module(module_path)
+            loaded_count += 1
+        except Exception:
+            continue
+
+    return loaded_count
+
+
+def get_registered_states() -> dict:
+    """Get all registered states from ScreenPilot"""
+    states = {}
+    for state_name, data in ScreenPilot._graph.nodes(data=True):
+        state_cls = data.get("cls")
+        if state_cls:
+            states[state_name] = {
+                "description": getattr(state_cls, "description", "No description"),
+                "class": state_cls,
+            }
+    return states
+
+
+def classify_current_state() -> tuple[bool, str, str]:
+    """Classify the current GUI state using Vision. Reloads states first."""
+    try:
+        # Always reload states to pick up any changes
+        with console.status("[dim]Reloading states...", spinner="dots") as status:
+            reload_states()
+            status.update("[green]+[/green] Reloaded states")
+            time.sleep(0.3)  # Brief pause to show success
+
+        states = get_registered_states()
+
+        if not states:
+            return (
+                False,
+                "",
+                "No states found. Make sure state definitions exist in your project.",
+            )
+
+        # Convert to format expected by Vision.classify_state
+        possible_states = [
+            {"id": name, "description": data["description"]}
+            for name, data in states.items()
+        ]
+
+        with console.status(
+            "[dim]Classifying current state (waiting for AI)...", spinner="dots"
+        ):
+            # Pass output_model=None to get tuple instead of BaseModel
+            result: BaseState = VISION_CLIENT.classify_state(possible_states)  # type: ignore[arg-type]
+
+        console.print("[green]+[/green] Classification complete")
+        return True, result.id, result.description
+    except Exception:
+        return False, "", f"Classification failed: {traceback.format_exc()}"
+
+
+def print_welcome():
+    """Print welcome message"""
+    title = Text("GUI Automation Interactive Test Session", style="bold cyan")
+    panel = Panel(title, border_style="cyan", padding=(1, 2))
+    console.print()
+    console.print(panel)
+    console.print()
+    console.print("[bold blue]Commands:[/bold blue]")
+    console.print(
+        "  [dim]classify_state: Classify current GUI state (auto-reloads states)[/dim]"
+    )
+    console.print("  [dim]exit: End session[/dim]")
+    console.print()
+    console.print("[bold blue]Testing actions:[/bold blue]")
+    console.print("  [dim]Type an action and press Enter to execute[/dim]")
+    console.print()
+
+
+def perform_single_action(action_string: str) -> tuple[bool, Any, str]:
+    """Execute a single action and return success status, result, and error message"""
+    try:
+        # Ensure action has .do() call
+        if not "do(" in action_string:
+            action_string = f"{action_string}.do()"
+
+        # Execute and capture result
+        result = eval(action_string)
+        return True, result, ""
+    except Exception as e:
+        error_msg = traceback.format_exc()
+        return False, None, error_msg
+
+
+def handle_special_command(command: str) -> tuple[bool, str]:
+    """Handle special commands like classify. Returns (is_special, message)"""
+    command = command.strip()
+
+    # Classify command
+    if command == "classify_state":
+        success, state_id, description = classify_current_state()
+        if success:
+            # Return empty string since console.print handles it
+            console.print()
+            console.print(f"[green]Current State:[/green] [bold]{state_id}[/bold]")
+            console.print(f"  [dim]{description}[/dim]")
+            console.print()
+            return True, ""
+        else:
+            console.print(f"[red]{description}[/red]")
+            return True, ""
+
+    return False, ""
+
+
+def format_result(result):
+    """Format action result for rich display"""
+    if result is None:
+        return "[dim](no return value)[/dim]"
+    elif isinstance(result, bool):
+        color = "green" if result else "yellow"
+        return f"[{color}]{result}[/{color}]"
+    elif isinstance(result, (str, int, float)):
+        return f"[cyan]{repr(result)}[/cyan]"
+    else:
+        return f"[cyan]{type(result).__name__}: {str(result)[:100]}[/cyan]"
+
+
+@gui_automation()
+def start_interactive_session(payload: ClerkCodePayload):
+    """Start an interactive test session with websocket connection"""
+    session_start = datetime.now()
+    action_count = 0
+
+    print_welcome()
+
+    # The gui_automation decorator establishes the connection before this function runs
+    # By the time we get here, connection is already established
+    console.print("[green]+[/green] WebSocket connection established")
+    console.print()
+
+    # Mark session as active
+    SESSION_FILE.touch()
+
+    try:
+        while True:
+            # Get input from user
+            try:
+                action_string = console.input(
+                    "[bold blue]command/action>[/bold blue] "
+                ).strip()
+            except EOFError:
+                break
+
+            # Check for exit command
+            if action_string.lower() in ["exit", "quit", "q"]:
+                break
+
+            # Skip empty input
+            if not action_string:
+                continue
+
+            # Check if it's a special command
+            is_special, message = handle_special_command(action_string)
+            if is_special:
+                if message:  # Only print if there's a message
+                    console.print(message)
+                continue
+
+            # Record action
+            ACTION_HISTORY.append(
+                {"timestamp": datetime.now(), "action": action_string, "success": None}
+            )
+
+            # Execute action with status
+            start_time = time.time()
+
+            with console.status(
+                "[dim]Executing action (waiting for tool)...", spinner="dots"
+            ):
+                success, result, error_msg = perform_single_action(action_string)
+                execution_time = time.time() - start_time
+
+            # Show completion message
+            if success:
+                console.print(
+                    f"[green]+[/green] Action completed ({execution_time:.3f}s)"
+                )
+            else:
+                console.print(f"[red]x[/red] Action failed ({execution_time:.3f}s)")
+
+            # Update history
+            ACTION_HISTORY[-1]["success"] = success
+            ACTION_HISTORY[-1]["execution_time"] = execution_time
+            ACTION_HISTORY[-1]["result"] = result
+
+            # Display result
+            if success:
+                action_count += 1
+                if result is not None:
+                    console.print(f"  Result: {format_result(result)}")
+            else:
+                console.print(f"[red]{error_msg}[/red]")
+
+            console.print()  # Extra newline for spacing
+
+    except KeyboardInterrupt:
+        console.print("\n\n[yellow]Session interrupted by user[/yellow]")
+    finally:
+        if SESSION_FILE.exists():
+            SESSION_FILE.unlink()
+
+        # Print summary
+        console.print("\n[bold]" + "=" * 80 + "[/bold]")
+        console.print("[bold]Session Summary[/bold]")
+        console.print("[bold]" + "=" * 80 + "[/bold]")
+        console.print(f"  Total actions executed: {action_count}")
+        console.print(f"  Session duration: {datetime.now() - session_start}")
+
+        if ACTION_HISTORY:
+            successful = sum(1 for a in ACTION_HISTORY if a.get("success"))
+            failed = len(ACTION_HISTORY) - successful
+            console.print(f"  Successful: [green]{successful}[/green]")
+            console.print(f"  Failed: [red]{failed}[/red]")
+
+        console.print("\n[blue]WebSocket connection closed[/blue]\n")
+
+
+def main():
+    """Main entry point for the gui_test_session command"""
+    # Start interactive session
+    load_dotenv()
+    payload = ClerkCodePayload(
+        document=Document(id="test-session"),
+        structured_data={},
+        run_id="test-session-run",
+    )
+
+    # Show spinner while the decorator establishes WebSocket connection
+    with console.status("[dim]Waiting for tool to connect...", spinner="dots"):
+        start_interactive_session(payload)
+
+
+if __name__ == "__main__":
+    main()