cyberdesk 0.2.1__py3-none-any.whl

cyberdesk/__init__.py

@@ -0,0 +1 @@
+from .client import CyberdeskClient 

cyberdesk/client.py

@@ -0,0 +1,108 @@
+"""
+Cyberdesk Python SDK wrapper client.
+"""
+
+from openapi_client.api_reference_client.client import Client
+from openapi_client.api_reference_client.api.desktop import (
+    get_v1_desktop_id,
+    post_v1_desktop,
+    post_v1_desktop_id_stop,
+    post_v1_desktop_id_computer_action,
+    post_v1_desktop_id_bash_action,
+)
+from openapi_client.api_reference_client.models import (
+    PostV1DesktopBody,
+    PostV1DesktopIdBashActionBody,
+    PostV1DesktopIdComputerActionClickMouseAction,
+    PostV1DesktopIdComputerActionDragMouseAction,
+    PostV1DesktopIdComputerActionGetCursorPositionAction,
+    PostV1DesktopIdComputerActionMoveMouseAction,
+    PostV1DesktopIdComputerActionPressKeysAction,
+    PostV1DesktopIdComputerActionScreenshotAction,
+    PostV1DesktopIdComputerActionScrollAction,
+    PostV1DesktopIdComputerActionTypeTextAction,
+    PostV1DesktopIdComputerActionWaitAction,
+)
+
+class CyberdeskClient:
+    """
+    Wrapper client for the Cyberdesk API.
+    Provides both synchronous and asynchronous methods.
+    """
+    def __init__(self, api_key: str, base_url: str = "https://api.cyberdesk.io"):
+        self.api_key = api_key
+        self.client = Client(base_url=base_url, headers={"x-api-key": api_key})
+
+    def get_desktop(self, id: str):
+        """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: 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)
+
+    def launch_desktop(self, timeout_ms: int = None):
+        """Synchronous: Create a new virtual desktop instance."""
+        body = PostV1DesktopBody(timeout_ms=timeout_ms) if timeout_ms is not None else PostV1DesktopBody()
+        return post_v1_desktop.sync(client=self.client, body=body, x_api_key=self.api_key)
+
+    async def async_launch_desktop(self, timeout_ms: int = None):
+        """Async: Create a new virtual desktop instance. Use with 'await'."""
+        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):
+        """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: 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):
+        """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)
+
+    async def async_execute_computer_action(self, id: str, action: dict):
+        """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)
+
+    def execute_bash_action(self, id: str, command: str):
+        """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: 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-0.2.1.dist-info/METADATA

@@ -0,0 +1,137 @@
+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

@@ -0,0 +1,7 @@
+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,,

cyberdesk-0.2.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.3.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cyberdesk-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Cyberdesk Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

cyberdesk-0.2.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+cyberdesk