cyberdesk 0.2.1__py3-none-any.whl → 0.2.2__py3-none-any.whl

cyberdesk/__init__.py

@@ -1 +1,8 @@
-from .client import CyberdeskClient 
+from .client import CyberdeskClient
+from .types import (
+    GetDesktopParams,
+    LaunchDesktopParams,
+    TerminateDesktopParams,
+    ExecuteComputerActionParams,
+    ExecuteBashActionParams,
+) 

cyberdesk/actions.py

@@ -0,0 +1,38 @@
+from .types import (
+    PostV1DesktopIdComputerActionClickMouseAction,
+    PostV1DesktopIdComputerActionDragMouseAction,
+    PostV1DesktopIdComputerActionGetCursorPositionAction,
+    PostV1DesktopIdComputerActionMoveMouseAction,
+    PostV1DesktopIdComputerActionPressKeysAction,
+    PostV1DesktopIdComputerActionScreenshotAction,
+    PostV1DesktopIdComputerActionScrollAction,
+    PostV1DesktopIdComputerActionTypeTextAction,
+    PostV1DesktopIdComputerActionWaitAction,
+)
+
+def click_mouse(x: int, y: int, button: str = "left") -> PostV1DesktopIdComputerActionClickMouseAction:
+    return PostV1DesktopIdComputerActionClickMouseAction(type="click_mouse", x=x, y=y, button=button)
+
+def drag_mouse(start_x: int, start_y: int, end_x: int, end_y: int, button: str = "left") -> PostV1DesktopIdComputerActionDragMouseAction:
+    return PostV1DesktopIdComputerActionDragMouseAction(type="drag_mouse", start_x=start_x, start_y=start_y, end_x=end_x, end_y=end_y, button=button)
+
+def get_cursor_position() -> PostV1DesktopIdComputerActionGetCursorPositionAction:
+    return PostV1DesktopIdComputerActionGetCursorPositionAction(type="get_cursor_position")
+
+def move_mouse(x: int, y: int) -> PostV1DesktopIdComputerActionMoveMouseAction:
+    return PostV1DesktopIdComputerActionMoveMouseAction(type="move_mouse", x=x, y=y)
+
+def press_keys(keys: list[str]) -> PostV1DesktopIdComputerActionPressKeysAction:
+    return PostV1DesktopIdComputerActionPressKeysAction(type="press_keys", keys=keys)
+
+def screenshot() -> PostV1DesktopIdComputerActionScreenshotAction:
+    return PostV1DesktopIdComputerActionScreenshotAction(type="screenshot")
+
+def scroll(dx: int, dy: int) -> PostV1DesktopIdComputerActionScrollAction:
+    return PostV1DesktopIdComputerActionScrollAction(type="scroll", dx=dx, dy=dy)
+
+def type_text(text: str) -> PostV1DesktopIdComputerActionTypeTextAction:
+    return PostV1DesktopIdComputerActionTypeTextAction(type="type", text=text)
+
+def wait(ms: int) -> PostV1DesktopIdComputerActionWaitAction:
+    return PostV1DesktopIdComputerActionWaitAction(type="wait", ms=ms) 

cyberdesk/client.py

@@ -2,6 +2,12 @@
 Cyberdesk Python SDK wrapper client.
 """
 
+from .types import (
+    GetDesktopParams,
+    TerminateDesktopParams,
+    ExecuteBashActionParams,
+    ComputerActionModel,
+)
 from openapi_client.api_reference_client.client import Client
 from openapi_client.api_reference_client.api.desktop import (
     get_v1_desktop_id,
@@ -13,15 +19,6 @@ from openapi_client.api_reference_client.api.desktop import (
 from openapi_client.api_reference_client.models import (
     PostV1DesktopBody,
     PostV1DesktopIdBashActionBody,
-    PostV1DesktopIdComputerActionClickMouseAction,
-    PostV1DesktopIdComputerActionDragMouseAction,
-    PostV1DesktopIdComputerActionGetCursorPositionAction,
-    PostV1DesktopIdComputerActionMoveMouseAction,
-    PostV1DesktopIdComputerActionPressKeysAction,
-    PostV1DesktopIdComputerActionScreenshotAction,
-    PostV1DesktopIdComputerActionScrollAction,
-    PostV1DesktopIdComputerActionTypeTextAction,
-    PostV1DesktopIdComputerActionWaitAction,
 )
 
 class CyberdeskClient:
@@ -33,11 +30,11 @@ class CyberdeskClient:
         self.api_key = api_key
         self.client = Client(base_url=base_url, headers={"x-api-key": api_key})
 
-    def get_desktop(self, id: str):
+    def get_desktop(self, id: GetDesktopParams):
         """Synchronous: Get details of a specific desktop instance."""
         return get_v1_desktop_id.sync(id=id, client=self.client, x_api_key=self.api_key)
 
-    async def async_get_desktop(self, id: str):
+    async def async_get_desktop(self, id: GetDesktopParams):
         """Async: Get details of a specific desktop instance. Use with 'await'."""
         return await get_v1_desktop_id.asyncio(id=id, client=self.client, x_api_key=self.api_key)
 
@@ -51,58 +48,28 @@ class CyberdeskClient:
         body = PostV1DesktopBody(timeout_ms=timeout_ms) if timeout_ms is not None else PostV1DesktopBody()
         return await post_v1_desktop.asyncio(client=self.client, body=body, x_api_key=self.api_key)
 
-    def terminate_desktop(self, id: str):
+    def terminate_desktop(self, id: TerminateDesktopParams):
         """Synchronous: Stop a running desktop instance."""
         return post_v1_desktop_id_stop.sync(id=id, client=self.client, x_api_key=self.api_key)
 
-    async def async_terminate_desktop(self, id: str):
+    async def async_terminate_desktop(self, id: TerminateDesktopParams):
         """Async: Stop a running desktop instance. Use with 'await'."""
         return await post_v1_desktop_id_stop.asyncio(id=id, client=self.client, x_api_key=self.api_key)
 
-    def execute_computer_action(self, id: str, action: dict):
+    def execute_computer_action(self, id: GetDesktopParams, action: ComputerActionModel):
         """Synchronous: Perform an action on the desktop (mouse, keyboard, etc)."""
-        action_type = action.get("type")
-        model_cls = {
-            "click_mouse": PostV1DesktopIdComputerActionClickMouseAction,
-            "scroll": PostV1DesktopIdComputerActionScrollAction,
-            "move_mouse": PostV1DesktopIdComputerActionMoveMouseAction,
-            "drag_mouse": PostV1DesktopIdComputerActionDragMouseAction,
-            "type": PostV1DesktopIdComputerActionTypeTextAction,
-            "press_keys": PostV1DesktopIdComputerActionPressKeysAction,
-            "wait": PostV1DesktopIdComputerActionWaitAction,
-            "screenshot": PostV1DesktopIdComputerActionScreenshotAction,
-            "get_cursor_position": PostV1DesktopIdComputerActionGetCursorPositionAction,
-        }.get(action_type)
-        if model_cls is None:
-            raise ValueError(f"Unknown computer action type: {action_type}")
-        model = model_cls.from_dict(action)
-        return post_v1_desktop_id_computer_action.sync(id=id, client=self.client, body=model, x_api_key=self.api_key)
+        return post_v1_desktop_id_computer_action.sync(id=id, client=self.client, body=action, x_api_key=self.api_key)
 
-    async def async_execute_computer_action(self, id: str, action: dict):
+    async def async_execute_computer_action(self, id: GetDesktopParams, action: ComputerActionModel):
         """Async: Perform an action on the desktop (mouse, keyboard, etc). Use with 'await'."""
-        action_type = action.get("type")
-        model_cls = {
-            "click_mouse": PostV1DesktopIdComputerActionClickMouseAction,
-            "scroll": PostV1DesktopIdComputerActionScrollAction,
-            "move_mouse": PostV1DesktopIdComputerActionMoveMouseAction,
-            "drag_mouse": PostV1DesktopIdComputerActionDragMouseAction,
-            "type": PostV1DesktopIdComputerActionTypeTextAction,
-            "press_keys": PostV1DesktopIdComputerActionPressKeysAction,
-            "wait": PostV1DesktopIdComputerActionWaitAction,
-            "screenshot": PostV1DesktopIdComputerActionScreenshotAction,
-            "get_cursor_position": PostV1DesktopIdComputerActionGetCursorPositionAction,
-        }.get(action_type)
-        if model_cls is None:
-            raise ValueError(f"Unknown computer action type: {action_type}")
-        model = model_cls.from_dict(action)
-        return await post_v1_desktop_id_computer_action.asyncio(id=id, client=self.client, body=model, x_api_key=self.api_key)
+        return await post_v1_desktop_id_computer_action.asyncio(id=id, client=self.client, body=action, x_api_key=self.api_key)
 
-    def execute_bash_action(self, id: str, command: str):
+    def execute_bash_action(self, id: GetDesktopParams, command: ExecuteBashActionParams):
         """Synchronous: Execute a bash command on the desktop."""
         body = PostV1DesktopIdBashActionBody(command=command)
         return post_v1_desktop_id_bash_action.sync(id=id, client=self.client, body=body, x_api_key=self.api_key)
 
-    async def async_execute_bash_action(self, id: str, command: str):
+    async def async_execute_bash_action(self, id: GetDesktopParams, command: ExecuteBashActionParams):
         """Async: Execute a bash command on the desktop. Use with 'await'."""
         body = PostV1DesktopIdBashActionBody(command=command)
         return await post_v1_desktop_id_bash_action.asyncio(id=id, client=self.client, body=body, x_api_key=self.api_key) 

cyberdesk/types.py

@@ -0,0 +1,50 @@
+from openapi_client.api_reference_client.models import (
+    PostV1DesktopBody,
+    PostV1DesktopIdComputerActionClickMouseAction,
+    PostV1DesktopIdComputerActionDragMouseAction,
+    PostV1DesktopIdComputerActionGetCursorPositionAction,
+    PostV1DesktopIdComputerActionMoveMouseAction,
+    PostV1DesktopIdComputerActionPressKeysAction,
+    PostV1DesktopIdComputerActionScreenshotAction,
+    PostV1DesktopIdComputerActionScrollAction,
+    PostV1DesktopIdComputerActionTypeTextAction,
+    PostV1DesktopIdComputerActionWaitAction,
+)
+from typing import Union
+
+# Named parameter types for SDK methods
+GetDesktopParams = str  # Desktop ID
+LaunchDesktopParams = PostV1DesktopBody
+TerminateDesktopParams = str  # Desktop ID
+ExecuteBashActionParams = str  # Command string
+
+# Strongly-typed union for all computer action models
+ComputerActionModel = Union[
+    PostV1DesktopIdComputerActionClickMouseAction,
+    PostV1DesktopIdComputerActionDragMouseAction,
+    PostV1DesktopIdComputerActionGetCursorPositionAction,
+    PostV1DesktopIdComputerActionMoveMouseAction,
+    PostV1DesktopIdComputerActionPressKeysAction,
+    PostV1DesktopIdComputerActionScreenshotAction,
+    PostV1DesktopIdComputerActionScrollAction,
+    PostV1DesktopIdComputerActionTypeTextAction,
+    PostV1DesktopIdComputerActionWaitAction,
+]
+
+# Re-export action models for ergonomic imports
+__all__ = [
+    "GetDesktopParams",
+    "LaunchDesktopParams",
+    "TerminateDesktopParams",
+    "ExecuteBashActionParams",
+    "ComputerActionModel",
+    "PostV1DesktopIdComputerActionClickMouseAction",
+    "PostV1DesktopIdComputerActionDragMouseAction",
+    "PostV1DesktopIdComputerActionGetCursorPositionAction",
+    "PostV1DesktopIdComputerActionMoveMouseAction",
+    "PostV1DesktopIdComputerActionPressKeysAction",
+    "PostV1DesktopIdComputerActionScreenshotAction",
+    "PostV1DesktopIdComputerActionScrollAction",
+    "PostV1DesktopIdComputerActionTypeTextAction",
+    "PostV1DesktopIdComputerActionWaitAction",
+] 

cyberdesk-0.2.2.dist-info/METADATA

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: cyberdesk
+Version: 0.2.2
+Summary: The official Python SDK for Cyberdesk
+Author-email: Cyberdesk Team <dev@cyberdesk.io>
+License-Expression: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx
+Provides-Extra: dev
+Requires-Dist: openapi-python-client; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# cyberdesk
+
+[![PyPI version](https://badge.fury.io/py/cyberdesk.svg)](https://badge.fury.io/py/cyberdesk)
+
+The official Python SDK for Cyberdesk.
+
+## Installation
+
+```bash
+pip install cyberdesk
+```
+
+## Usage
+
+First, create a Cyberdesk client instance with your API key:
+
+```python
+from cyberdesk import CyberdeskClient
+
+client = CyberdeskClient(api_key="YOUR_API_KEY")
+```
+
+---
+
+### Launch a Desktop
+
+```python
+result = client.launch_desktop(timeout_ms=10000)  # Optional: set a timeout for the desktop session
+
+# Error handling example
+if hasattr(result, 'error') and result.error:
+    raise Exception('Failed to launch desktop: ' + str(result.error))
+
+# Success
+if hasattr(result, 'id'):
+    desktop_id = result.id
+    print('Launched desktop with ID:', desktop_id)
+```
+
+---
+
+### Get Desktop Info
+
+```python
+info = client.get_desktop("your-desktop-id")
+
+if hasattr(info, 'error') and info.error:
+    raise Exception('Failed to get desktop info: ' + str(info.error))
+
+print('Desktop info:', info)
+```
+
+---
+
+### Perform a Computer Action (e.g., Mouse Click)
+
+```python
+from cyberdesk.actions import click_mouse
+
+action = click_mouse(x=100, y=150, button="left")
+action_result = client.execute_computer_action("your-desktop-id", action)
+
+if hasattr(action_result, 'error') and action_result.error:
+    raise Exception('Action failed: ' + str(action_result.error))
+
+print('Action result:', action_result)
+```
+
+---
+
+### Run a Bash Command
+
+```python
+bash_result = client.execute_bash_action(
+    "your-desktop-id",
+    "echo Hello, world!"
+)
+
+if hasattr(bash_result, 'error') and bash_result.error:
+    raise Exception('Bash command failed: ' + str(bash_result.error))
+
+print('Bash output:', getattr(bash_result, 'output', bash_result))
+```
+
+---
+
+## Ergonomic, Type-Safe Actions
+
+To create computer actions (mouse, keyboard, etc.), use the factory functions in `cyberdesk.actions`. These provide full type hints and IDE autocompletion for all required and optional fields.
+
+**Example:**
+```python
+from cyberdesk.actions import click_mouse, type_text
+
+action1 = click_mouse(x=100, y=200, button="left")
+action2 = type_text(text="Hello, world!")
+
+client.execute_computer_action("your-desktop-id", action1)
+client.execute_computer_action("your-desktop-id", action2)
+```
+
+| Action         | Factory Function         | Description                |
+|----------------|-------------------------|----------------------------|
+| Click Mouse    | `click_mouse`           | Mouse click at (x, y)      |
+| Drag Mouse     | `drag_mouse`            | Mouse drag from/to (x, y)  |
+| Move Mouse     | `move_mouse`            | Move mouse to (x, y)       |
+| Scroll         | `scroll`                | Scroll by dx, dy           |
+| Type Text      | `type_text`             | Type text                  |
+| Press Keys     | `press_keys`            | Press keyboard keys        |
+| Screenshot     | `screenshot`            | Take a screenshot          |
+| Wait           | `wait`                  | Wait for ms milliseconds   |
+| Get Cursor Pos | `get_cursor_position`   | Get mouse cursor position  |
+
+---
+
+## Async Usage
+
+All methods are also available as async variants (prefixed with `async_`). Example:
+
+```python
+import asyncio
+from cyberdesk import CyberdeskClient
+from cyberdesk.actions import click_mouse
+
+async def main():
+    client = CyberdeskClient(api_key="YOUR_API_KEY")
+    result = await client.async_launch_desktop(timeout_ms=10000)
+    print(result)
+    # Example async computer action
+    action = click_mouse(x=100, y=200)
+    await client.async_execute_computer_action("your-desktop-id", action)
+    # ... use other async_ methods as needed
+
+asyncio.run(main())
+```
+
+---
+
+## Type Hints and Models
+
+All request/response types are available from the generated models, and all computer actions are available as factory functions in `cyberdesk.actions` for ergonomic, type-safe usage.
+
+```python
+from cyberdesk.actions import click_mouse, drag_mouse, type_text, wait, scroll, move_mouse, press_keys, screenshot, get_cursor_position
+```
+
+---
+
+## For Cyberdesk Team: Publishing to PyPI
+
+**Recommended:** Always use a [virtual environment](https://docs.python.org/3/library/venv.html) (venv) for building and publishing to avoid dependency conflicts.
+
+To build and publish this package to [PyPI](https://pypi.org/project/cyberdesk/):
+
+1. **Log into PyPI** (get credentials from the Cyberdesk team).
+
+2. **Install dev dependencies** (in a clean venv):
+   ```bash
+   pip install .[dev]
+   # or
+   uv pip install .[dev]
+   ```
+
+3. **Build the package:**
+   ```bash
+   python -m build
+   ```
+   This creates a `dist/` directory with `.whl` and `.tar.gz` files.
+
+4. **(Recommended) Set up a `.pypirc` file for easy publishing:**
+   - Create a file named `.pypirc` in your home directory (e.g., `C:\Users\yourname\.pypirc` on Windows or `~/.pypirc` on Linux/macOS).
+   - Add:
+     ```ini
+     [distutils]
+     index-servers =
+         pypi
+
+     [pypi]
+     username = __token__
+     password = pypi-AgEIcH...   # <-- paste your API token here
+     ```
+
+5. **Publish to PyPI:**
+   ```bash
+   twine upload dist/*
+   ```
+   - If you set up `.pypirc`, you won't be prompted for credentials.
+   - If not, enter `__token__` as the username and paste your API token as the password.
+
+6. **Verify:**
+   - Visit https://pypi.org/project/cyberdesk/ to see your published package.
+   - Try installing it in a fresh environment:
+     ```bash
+     pip install cyberdesk
+     ```
+
+---
+
+## License
+
+[MIT](LICENSE) 

cyberdesk-0.2.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+cyberdesk/__init__.py,sha256=6w_HoySYYfkbEefmGaG4X_YPsC899Rf5Bm_7I2h0hoU,203
+cyberdesk/actions.py,sha256=QHDje98UhRRueTEc-nCV0NKJ_vLRGHtce1N_7b33si0,2106
+cyberdesk/client.py,sha256=7o1bZDiUom_kB6dRnL_n1F0yDGBI5kT9oOCNbMhIKOI,3881
+cyberdesk/types.py,sha256=n2x8OVVwOvkBkiNV5k6PQcMeFkNqCZ5u4bOC4Sm5rmk,2024
+cyberdesk-0.2.2.dist-info/licenses/LICENSE,sha256=2KwiXv5ggnOI_pTkar6DJhkvlsThyfiA1-Q-CKTYP3U,1091
+cyberdesk-0.2.2.dist-info/METADATA,sha256=x6EMfZz_pcVx_lbFst9etBa_gS6H16ExgidEk0xNe68,6130
+cyberdesk-0.2.2.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+cyberdesk-0.2.2.dist-info/top_level.txt,sha256=CdS7JHYf_tUvJj-XyQ0reLcOLsfrzCFxWQS1apfMkGM,10
+cyberdesk-0.2.2.dist-info/RECORD,,

cyberdesk-0.2.1.dist-info/METADATA

@@ -1,137 +0,0 @@
-Metadata-Version: 2.4
-Name: cyberdesk
-Version: 0.2.1
-Summary: The official Python SDK for Cyberdesk
-Author-email: Cyberdesk Team <dev@cyberdesk.io>
-License-Expression: MIT
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: httpx
-Provides-Extra: dev
-Requires-Dist: openapi-python-client; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Dynamic: license-file
-
-# cyberdesk
-
-[![PyPI version](https://badge.fury.io/py/cyberdesk.svg)](https://badge.fury.io/py/cyberdesk)
-
-The official Python SDK for Cyberdesk.
-
-## Installation
-
-```bash
-pip install cyberdesk
-```
-
-## Usage
-
-First, create a Cyberdesk client instance with your API key:
-
-```python
-from cyberdesk import CyberdeskClient
-
-client = CyberdeskClient(api_key="YOUR_API_KEY")
-```
-
----
-
-### Launch a Desktop
-
-```python
-result = client.launch_desktop(timeout_ms=10000)  # Optional: set a timeout for the desktop session
-
-# Error handling example
-if hasattr(result, 'error') and result.error:
-    raise Exception('Failed to launch desktop: ' + str(result.error))
-
-# Success
-if hasattr(result, 'id'):
-    desktop_id = result.id
-    print('Launched desktop with ID:', desktop_id)
-```
-
----
-
-### Get Desktop Info
-
-```python
-info = client.get_desktop("your-desktop-id")
-
-if hasattr(info, 'error') and info.error:
-    raise Exception('Failed to get desktop info: ' + str(info.error))
-
-print('Desktop info:', info)
-```
-
----
-
-### Perform a Computer Action (e.g., Mouse Click)
-
-```python
-action_result = client.execute_computer_action(
-    "your-desktop-id",
-    {
-        "type": "click_mouse",
-        "x": 100,
-        "y": 150
-    }
-)
-
-if hasattr(action_result, 'error') and action_result.error:
-    raise Exception('Action failed: ' + str(action_result.error))
-
-print('Action result:', action_result)
-```
-
----
-
-### Run a Bash Command
-
-```python
-bash_result = client.execute_bash_action(
-    "your-desktop-id",
-    "echo Hello, world!"
-)
-
-if hasattr(bash_result, 'error') and bash_result.error:
-    raise Exception('Bash command failed: ' + str(bash_result.error))
-
-print('Bash output:', getattr(bash_result, 'output', bash_result))
-```
-
----
-
-## Async Usage
-
-All methods are also available as async variants (prefixed with `async_`). Example:
-
-```python
-import asyncio
-from cyberdesk import CyberdeskClient
-
-async def main():
-    client = CyberdeskClient(api_key="YOUR_API_KEY")
-    result = await client.async_launch_desktop(timeout_ms=10000)
-    print(result)
-    # ... use other async_ methods as needed
-
-asyncio.run(main())
-```
-
----
-
-## Type Hints and Models
-
-All request/response types are available from the generated models:
-
-```python
-from openapi_client.api_reference_client.models import PostV1DesktopBody, PostV1DesktopIdBashActionBody
-```
-
----
-
-## License
-
-[MIT](LICENSE) 

cyberdesk-0.2.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-cyberdesk/__init__.py,sha256=G5ewrCDKWu9oCVWHvpeEB4YqKrnqzvf9ZJlCTtAedBA,36
-cyberdesk/client.py,sha256=Hc5Z47cPAYCWcMBi0Ye53zkJ8YumP5wI9z5PQq-yAG8,5818
-cyberdesk-0.2.1.dist-info/licenses/LICENSE,sha256=2KwiXv5ggnOI_pTkar6DJhkvlsThyfiA1-Q-CKTYP3U,1091
-cyberdesk-0.2.1.dist-info/METADATA,sha256=XgmkoXBOmHxjQWnEmSJt2N_yQ14BSucvlE8AdMr19xY,2933
-cyberdesk-0.2.1.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-cyberdesk-0.2.1.dist-info/top_level.txt,sha256=CdS7JHYf_tUvJj-XyQ0reLcOLsfrzCFxWQS1apfMkGM,10
-cyberdesk-0.2.1.dist-info/RECORD,,