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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of cyberdesk might be problematic. Click here for more details.

cyberdesk/__init__.py CHANGED
@@ -1 +1,8 @@
1
- from .client import CyberdeskClient
1
+ from .client import CyberdeskClient
2
+ from .types import (
3
+ GetDesktopParams,
4
+ LaunchDesktopParams,
5
+ TerminateDesktopParams,
6
+ ExecuteComputerActionParams,
7
+ ExecuteBashActionParams,
8
+ )
cyberdesk/actions.py ADDED
@@ -0,0 +1,38 @@
1
+ from .types import (
2
+ PostV1DesktopIdComputerActionClickMouseAction,
3
+ PostV1DesktopIdComputerActionDragMouseAction,
4
+ PostV1DesktopIdComputerActionGetCursorPositionAction,
5
+ PostV1DesktopIdComputerActionMoveMouseAction,
6
+ PostV1DesktopIdComputerActionPressKeysAction,
7
+ PostV1DesktopIdComputerActionScreenshotAction,
8
+ PostV1DesktopIdComputerActionScrollAction,
9
+ PostV1DesktopIdComputerActionTypeTextAction,
10
+ PostV1DesktopIdComputerActionWaitAction,
11
+ )
12
+
13
+ def click_mouse(x: int, y: int, button: str = "left") -> PostV1DesktopIdComputerActionClickMouseAction:
14
+ return PostV1DesktopIdComputerActionClickMouseAction(type="click_mouse", x=x, y=y, button=button)
15
+
16
+ def drag_mouse(start_x: int, start_y: int, end_x: int, end_y: int, button: str = "left") -> PostV1DesktopIdComputerActionDragMouseAction:
17
+ return PostV1DesktopIdComputerActionDragMouseAction(type="drag_mouse", start_x=start_x, start_y=start_y, end_x=end_x, end_y=end_y, button=button)
18
+
19
+ def get_cursor_position() -> PostV1DesktopIdComputerActionGetCursorPositionAction:
20
+ return PostV1DesktopIdComputerActionGetCursorPositionAction(type="get_cursor_position")
21
+
22
+ def move_mouse(x: int, y: int) -> PostV1DesktopIdComputerActionMoveMouseAction:
23
+ return PostV1DesktopIdComputerActionMoveMouseAction(type="move_mouse", x=x, y=y)
24
+
25
+ def press_keys(keys: list[str]) -> PostV1DesktopIdComputerActionPressKeysAction:
26
+ return PostV1DesktopIdComputerActionPressKeysAction(type="press_keys", keys=keys)
27
+
28
+ def screenshot() -> PostV1DesktopIdComputerActionScreenshotAction:
29
+ return PostV1DesktopIdComputerActionScreenshotAction(type="screenshot")
30
+
31
+ def scroll(dx: int, dy: int) -> PostV1DesktopIdComputerActionScrollAction:
32
+ return PostV1DesktopIdComputerActionScrollAction(type="scroll", dx=dx, dy=dy)
33
+
34
+ def type_text(text: str) -> PostV1DesktopIdComputerActionTypeTextAction:
35
+ return PostV1DesktopIdComputerActionTypeTextAction(type="type", text=text)
36
+
37
+ def wait(ms: int) -> PostV1DesktopIdComputerActionWaitAction:
38
+ return PostV1DesktopIdComputerActionWaitAction(type="wait", ms=ms)
cyberdesk/client.py CHANGED
@@ -1,108 +1,75 @@
1
- """
2
- Cyberdesk Python SDK wrapper client.
3
- """
4
-
5
- from openapi_client.api_reference_client.client import Client
6
- from openapi_client.api_reference_client.api.desktop import (
7
- get_v1_desktop_id,
8
- post_v1_desktop,
9
- post_v1_desktop_id_stop,
10
- post_v1_desktop_id_computer_action,
11
- post_v1_desktop_id_bash_action,
12
- )
13
- from openapi_client.api_reference_client.models import (
14
- PostV1DesktopBody,
15
- PostV1DesktopIdBashActionBody,
16
- PostV1DesktopIdComputerActionClickMouseAction,
17
- PostV1DesktopIdComputerActionDragMouseAction,
18
- PostV1DesktopIdComputerActionGetCursorPositionAction,
19
- PostV1DesktopIdComputerActionMoveMouseAction,
20
- PostV1DesktopIdComputerActionPressKeysAction,
21
- PostV1DesktopIdComputerActionScreenshotAction,
22
- PostV1DesktopIdComputerActionScrollAction,
23
- PostV1DesktopIdComputerActionTypeTextAction,
24
- PostV1DesktopIdComputerActionWaitAction,
25
- )
26
-
27
- class CyberdeskClient:
28
- """
29
- Wrapper client for the Cyberdesk API.
30
- Provides both synchronous and asynchronous methods.
31
- """
32
- def __init__(self, api_key: str, base_url: str = "https://api.cyberdesk.io"):
33
- self.api_key = api_key
34
- self.client = Client(base_url=base_url, headers={"x-api-key": api_key})
35
-
36
- def get_desktop(self, id: str):
37
- """Synchronous: Get details of a specific desktop instance."""
38
- return get_v1_desktop_id.sync(id=id, client=self.client, x_api_key=self.api_key)
39
-
40
- async def async_get_desktop(self, id: str):
41
- """Async: Get details of a specific desktop instance. Use with 'await'."""
42
- return await get_v1_desktop_id.asyncio(id=id, client=self.client, x_api_key=self.api_key)
43
-
44
- def launch_desktop(self, timeout_ms: int = None):
45
- """Synchronous: Create a new virtual desktop instance."""
46
- body = PostV1DesktopBody(timeout_ms=timeout_ms) if timeout_ms is not None else PostV1DesktopBody()
47
- return post_v1_desktop.sync(client=self.client, body=body, x_api_key=self.api_key)
48
-
49
- async def async_launch_desktop(self, timeout_ms: int = None):
50
- """Async: Create a new virtual desktop instance. Use with 'await'."""
51
- body = PostV1DesktopBody(timeout_ms=timeout_ms) if timeout_ms is not None else PostV1DesktopBody()
52
- return await post_v1_desktop.asyncio(client=self.client, body=body, x_api_key=self.api_key)
53
-
54
- def terminate_desktop(self, id: str):
55
- """Synchronous: Stop a running desktop instance."""
56
- return post_v1_desktop_id_stop.sync(id=id, client=self.client, x_api_key=self.api_key)
57
-
58
- async def async_terminate_desktop(self, id: str):
59
- """Async: Stop a running desktop instance. Use with 'await'."""
60
- return await post_v1_desktop_id_stop.asyncio(id=id, client=self.client, x_api_key=self.api_key)
61
-
62
- def execute_computer_action(self, id: str, action: dict):
63
- """Synchronous: Perform an action on the desktop (mouse, keyboard, etc)."""
64
- action_type = action.get("type")
65
- model_cls = {
66
- "click_mouse": PostV1DesktopIdComputerActionClickMouseAction,
67
- "scroll": PostV1DesktopIdComputerActionScrollAction,
68
- "move_mouse": PostV1DesktopIdComputerActionMoveMouseAction,
69
- "drag_mouse": PostV1DesktopIdComputerActionDragMouseAction,
70
- "type": PostV1DesktopIdComputerActionTypeTextAction,
71
- "press_keys": PostV1DesktopIdComputerActionPressKeysAction,
72
- "wait": PostV1DesktopIdComputerActionWaitAction,
73
- "screenshot": PostV1DesktopIdComputerActionScreenshotAction,
74
- "get_cursor_position": PostV1DesktopIdComputerActionGetCursorPositionAction,
75
- }.get(action_type)
76
- if model_cls is None:
77
- raise ValueError(f"Unknown computer action type: {action_type}")
78
- model = model_cls.from_dict(action)
79
- return post_v1_desktop_id_computer_action.sync(id=id, client=self.client, body=model, x_api_key=self.api_key)
80
-
81
- async def async_execute_computer_action(self, id: str, action: dict):
82
- """Async: Perform an action on the desktop (mouse, keyboard, etc). Use with 'await'."""
83
- action_type = action.get("type")
84
- model_cls = {
85
- "click_mouse": PostV1DesktopIdComputerActionClickMouseAction,
86
- "scroll": PostV1DesktopIdComputerActionScrollAction,
87
- "move_mouse": PostV1DesktopIdComputerActionMoveMouseAction,
88
- "drag_mouse": PostV1DesktopIdComputerActionDragMouseAction,
89
- "type": PostV1DesktopIdComputerActionTypeTextAction,
90
- "press_keys": PostV1DesktopIdComputerActionPressKeysAction,
91
- "wait": PostV1DesktopIdComputerActionWaitAction,
92
- "screenshot": PostV1DesktopIdComputerActionScreenshotAction,
93
- "get_cursor_position": PostV1DesktopIdComputerActionGetCursorPositionAction,
94
- }.get(action_type)
95
- if model_cls is None:
96
- raise ValueError(f"Unknown computer action type: {action_type}")
97
- model = model_cls.from_dict(action)
98
- return await post_v1_desktop_id_computer_action.asyncio(id=id, client=self.client, body=model, x_api_key=self.api_key)
99
-
100
- def execute_bash_action(self, id: str, command: str):
101
- """Synchronous: Execute a bash command on the desktop."""
102
- body = PostV1DesktopIdBashActionBody(command=command)
103
- return post_v1_desktop_id_bash_action.sync(id=id, client=self.client, body=body, x_api_key=self.api_key)
104
-
105
- async def async_execute_bash_action(self, id: str, command: str):
106
- """Async: Execute a bash command on the desktop. Use with 'await'."""
107
- body = PostV1DesktopIdBashActionBody(command=command)
1
+ """
2
+ Cyberdesk Python SDK wrapper client.
3
+ """
4
+
5
+ from .types import (
6
+ GetDesktopParams,
7
+ TerminateDesktopParams,
8
+ ExecuteBashActionParams,
9
+ ComputerActionModel,
10
+ )
11
+ from openapi_client.api_reference_client.client import Client
12
+ from openapi_client.api_reference_client.api.desktop import (
13
+ get_v1_desktop_id,
14
+ post_v1_desktop,
15
+ post_v1_desktop_id_stop,
16
+ post_v1_desktop_id_computer_action,
17
+ post_v1_desktop_id_bash_action,
18
+ )
19
+ from openapi_client.api_reference_client.models import (
20
+ PostV1DesktopBody,
21
+ PostV1DesktopIdBashActionBody,
22
+ )
23
+
24
+ class CyberdeskClient:
25
+ """
26
+ Wrapper client for the Cyberdesk API.
27
+ Provides both synchronous and asynchronous methods.
28
+ """
29
+ def __init__(self, api_key: str, base_url: str = "https://api.cyberdesk.io"):
30
+ self.api_key = api_key
31
+ self.client = Client(base_url=base_url, headers={"x-api-key": api_key})
32
+
33
+ def get_desktop(self, id: GetDesktopParams):
34
+ """Synchronous: Get details of a specific desktop instance."""
35
+ return get_v1_desktop_id.sync(id=id, client=self.client, x_api_key=self.api_key)
36
+
37
+ async def async_get_desktop(self, id: GetDesktopParams):
38
+ """Async: Get details of a specific desktop instance. Use with 'await'."""
39
+ return await get_v1_desktop_id.asyncio(id=id, client=self.client, x_api_key=self.api_key)
40
+
41
+ def launch_desktop(self, timeout_ms: int = None):
42
+ """Synchronous: Create a new virtual desktop instance."""
43
+ body = PostV1DesktopBody(timeout_ms=timeout_ms) if timeout_ms is not None else PostV1DesktopBody()
44
+ return post_v1_desktop.sync(client=self.client, body=body, x_api_key=self.api_key)
45
+
46
+ async def async_launch_desktop(self, timeout_ms: int = None):
47
+ """Async: Create a new virtual desktop instance. Use with 'await'."""
48
+ body = PostV1DesktopBody(timeout_ms=timeout_ms) if timeout_ms is not None else PostV1DesktopBody()
49
+ return await post_v1_desktop.asyncio(client=self.client, body=body, x_api_key=self.api_key)
50
+
51
+ def terminate_desktop(self, id: TerminateDesktopParams):
52
+ """Synchronous: Stop a running desktop instance."""
53
+ return post_v1_desktop_id_stop.sync(id=id, client=self.client, x_api_key=self.api_key)
54
+
55
+ async def async_terminate_desktop(self, id: TerminateDesktopParams):
56
+ """Async: Stop a running desktop instance. Use with 'await'."""
57
+ return await post_v1_desktop_id_stop.asyncio(id=id, client=self.client, x_api_key=self.api_key)
58
+
59
+ def execute_computer_action(self, id: GetDesktopParams, action: ComputerActionModel):
60
+ """Synchronous: Perform an action on the desktop (mouse, keyboard, etc)."""
61
+ return post_v1_desktop_id_computer_action.sync(id=id, client=self.client, body=action, x_api_key=self.api_key)
62
+
63
+ async def async_execute_computer_action(self, id: GetDesktopParams, action: ComputerActionModel):
64
+ """Async: Perform an action on the desktop (mouse, keyboard, etc). Use with 'await'."""
65
+ return await post_v1_desktop_id_computer_action.asyncio(id=id, client=self.client, body=action, x_api_key=self.api_key)
66
+
67
+ def execute_bash_action(self, id: GetDesktopParams, command: ExecuteBashActionParams):
68
+ """Synchronous: Execute a bash command on the desktop."""
69
+ body = PostV1DesktopIdBashActionBody(command=command)
70
+ return post_v1_desktop_id_bash_action.sync(id=id, client=self.client, body=body, x_api_key=self.api_key)
71
+
72
+ async def async_execute_bash_action(self, id: GetDesktopParams, command: ExecuteBashActionParams):
73
+ """Async: Execute a bash command on the desktop. Use with 'await'."""
74
+ body = PostV1DesktopIdBashActionBody(command=command)
108
75
  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 ADDED
@@ -0,0 +1,50 @@
1
+ from openapi_client.api_reference_client.models import (
2
+ PostV1DesktopBody,
3
+ PostV1DesktopIdComputerActionClickMouseAction,
4
+ PostV1DesktopIdComputerActionDragMouseAction,
5
+ PostV1DesktopIdComputerActionGetCursorPositionAction,
6
+ PostV1DesktopIdComputerActionMoveMouseAction,
7
+ PostV1DesktopIdComputerActionPressKeysAction,
8
+ PostV1DesktopIdComputerActionScreenshotAction,
9
+ PostV1DesktopIdComputerActionScrollAction,
10
+ PostV1DesktopIdComputerActionTypeTextAction,
11
+ PostV1DesktopIdComputerActionWaitAction,
12
+ )
13
+ from typing import Union
14
+
15
+ # Named parameter types for SDK methods
16
+ GetDesktopParams = str # Desktop ID
17
+ LaunchDesktopParams = PostV1DesktopBody
18
+ TerminateDesktopParams = str # Desktop ID
19
+ ExecuteBashActionParams = str # Command string
20
+
21
+ # Strongly-typed union for all computer action models
22
+ ComputerActionModel = Union[
23
+ PostV1DesktopIdComputerActionClickMouseAction,
24
+ PostV1DesktopIdComputerActionDragMouseAction,
25
+ PostV1DesktopIdComputerActionGetCursorPositionAction,
26
+ PostV1DesktopIdComputerActionMoveMouseAction,
27
+ PostV1DesktopIdComputerActionPressKeysAction,
28
+ PostV1DesktopIdComputerActionScreenshotAction,
29
+ PostV1DesktopIdComputerActionScrollAction,
30
+ PostV1DesktopIdComputerActionTypeTextAction,
31
+ PostV1DesktopIdComputerActionWaitAction,
32
+ ]
33
+
34
+ # Re-export action models for ergonomic imports
35
+ __all__ = [
36
+ "GetDesktopParams",
37
+ "LaunchDesktopParams",
38
+ "TerminateDesktopParams",
39
+ "ExecuteBashActionParams",
40
+ "ComputerActionModel",
41
+ "PostV1DesktopIdComputerActionClickMouseAction",
42
+ "PostV1DesktopIdComputerActionDragMouseAction",
43
+ "PostV1DesktopIdComputerActionGetCursorPositionAction",
44
+ "PostV1DesktopIdComputerActionMoveMouseAction",
45
+ "PostV1DesktopIdComputerActionPressKeysAction",
46
+ "PostV1DesktopIdComputerActionScreenshotAction",
47
+ "PostV1DesktopIdComputerActionScrollAction",
48
+ "PostV1DesktopIdComputerActionTypeTextAction",
49
+ "PostV1DesktopIdComputerActionWaitAction",
50
+ ]
@@ -0,0 +1,226 @@
1
+ Metadata-Version: 2.4
2
+ Name: cyberdesk
3
+ Version: 0.2.3
4
+ Summary: The official Python SDK for Cyberdesk
5
+ Author-email: Cyberdesk Team <dev@cyberdesk.io>
6
+ License-Expression: MIT
7
+ Description-Content-Type: text/markdown
8
+ License-File: LICENSE
9
+ Requires-Dist: httpx
10
+ Requires-Dist: openapi_client
11
+ Provides-Extra: dev
12
+ Requires-Dist: openapi-python-client; extra == "dev"
13
+ Requires-Dist: build; extra == "dev"
14
+ Requires-Dist: twine; extra == "dev"
15
+ Dynamic: license-file
16
+
17
+ # cyberdesk
18
+
19
+ [![PyPI version](https://badge.fury.io/py/cyberdesk.svg)](https://badge.fury.io/py/cyberdesk)
20
+
21
+ The official Python SDK for Cyberdesk.
22
+
23
+ ## Installation
24
+
25
+ ```bash
26
+ pip install cyberdesk
27
+ ```
28
+
29
+ ## Usage
30
+
31
+ First, create a Cyberdesk client instance with your API key:
32
+
33
+ ```python
34
+ from cyberdesk import CyberdeskClient
35
+
36
+ client = CyberdeskClient(api_key="YOUR_API_KEY")
37
+ ```
38
+
39
+ ---
40
+
41
+ ### Launch a Desktop
42
+
43
+ ```python
44
+ result = client.launch_desktop(timeout_ms=10000) # Optional: set a timeout for the desktop session
45
+
46
+ # Error handling example
47
+ if hasattr(result, 'error') and result.error:
48
+ raise Exception('Failed to launch desktop: ' + str(result.error))
49
+
50
+ # Success
51
+ if hasattr(result, 'id'):
52
+ desktop_id = result.id
53
+ print('Launched desktop with ID:', desktop_id)
54
+ ```
55
+
56
+ ---
57
+
58
+ ### Get Desktop Info
59
+
60
+ ```python
61
+ info = client.get_desktop("your-desktop-id")
62
+
63
+ if hasattr(info, 'error') and info.error:
64
+ raise Exception('Failed to get desktop info: ' + str(info.error))
65
+
66
+ print('Desktop info:', info)
67
+ ```
68
+
69
+ ---
70
+
71
+ ### Perform a Computer Action (e.g., Mouse Click)
72
+
73
+ ```python
74
+ from cyberdesk.actions import click_mouse
75
+
76
+ action = click_mouse(x=100, y=150, button="left")
77
+ action_result = client.execute_computer_action("your-desktop-id", action)
78
+
79
+ if hasattr(action_result, 'error') and action_result.error:
80
+ raise Exception('Action failed: ' + str(action_result.error))
81
+
82
+ print('Action result:', action_result)
83
+ ```
84
+
85
+ ---
86
+
87
+ ### Run a Bash Command
88
+
89
+ ```python
90
+ bash_result = client.execute_bash_action(
91
+ "your-desktop-id",
92
+ "echo Hello, world!"
93
+ )
94
+
95
+ if hasattr(bash_result, 'error') and bash_result.error:
96
+ raise Exception('Bash command failed: ' + str(bash_result.error))
97
+
98
+ print('Bash output:', getattr(bash_result, 'output', bash_result))
99
+ ```
100
+
101
+ ---
102
+
103
+ ## Ergonomic, Type-Safe Actions
104
+
105
+ 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.
106
+
107
+ **Example:**
108
+ ```python
109
+ from cyberdesk.actions import click_mouse, type_text
110
+
111
+ action1 = click_mouse(x=100, y=200, button="left")
112
+ action2 = type_text(text="Hello, world!")
113
+
114
+ client.execute_computer_action("your-desktop-id", action1)
115
+ client.execute_computer_action("your-desktop-id", action2)
116
+ ```
117
+
118
+ | Action | Factory Function | Description |
119
+ |----------------|-------------------------|----------------------------|
120
+ | Click Mouse | `click_mouse` | Mouse click at (x, y) |
121
+ | Drag Mouse | `drag_mouse` | Mouse drag from/to (x, y) |
122
+ | Move Mouse | `move_mouse` | Move mouse to (x, y) |
123
+ | Scroll | `scroll` | Scroll by dx, dy |
124
+ | Type Text | `type_text` | Type text |
125
+ | Press Keys | `press_keys` | Press keyboard keys |
126
+ | Screenshot | `screenshot` | Take a screenshot |
127
+ | Wait | `wait` | Wait for ms milliseconds |
128
+ | Get Cursor Pos | `get_cursor_position` | Get mouse cursor position |
129
+
130
+ ---
131
+
132
+ ## Async Usage
133
+
134
+ All methods are also available as async variants (prefixed with `async_`). Example:
135
+
136
+ ```python
137
+ import asyncio
138
+ from cyberdesk import CyberdeskClient
139
+ from cyberdesk.actions import click_mouse
140
+
141
+ async def main():
142
+ client = CyberdeskClient(api_key="YOUR_API_KEY")
143
+ result = await client.async_launch_desktop(timeout_ms=10000)
144
+ print(result)
145
+ # Example async computer action
146
+ action = click_mouse(x=100, y=200)
147
+ await client.async_execute_computer_action("your-desktop-id", action)
148
+ # ... use other async_ methods as needed
149
+
150
+ asyncio.run(main())
151
+ ```
152
+
153
+ ---
154
+
155
+ ## Type Hints and Models
156
+
157
+ 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.
158
+
159
+ ```python
160
+ from cyberdesk.actions import click_mouse, drag_mouse, type_text, wait, scroll, move_mouse, press_keys, screenshot, get_cursor_position
161
+ ```
162
+
163
+ ---
164
+
165
+ ## For Cyberdesk Team: Publishing to PyPI
166
+
167
+ **Recommended:** Always use a [virtual environment](https://docs.python.org/3/library/venv.html) (venv) for building and publishing to avoid dependency conflicts.
168
+
169
+ To build and publish this package to [PyPI](https://pypi.org/project/cyberdesk/):
170
+
171
+ 1. **Log into PyPI** (get credentials from the Cyberdesk team).
172
+
173
+ 2. **Install dev dependencies** (in a clean venv):
174
+ ```bash
175
+ pip install .[dev]
176
+ # or
177
+ uv pip install .[dev]
178
+ ```
179
+
180
+ 3. **Bump the version number** in `pyproject.toml` (e.g., `version = "0.2.4"`).
181
+
182
+ 4. **Clean your `dist/` directory** before building to avoid 'File already exists' errors:
183
+ ```bash
184
+ rm -rf dist/*
185
+ # On Windows PowerShell:
186
+ Remove-Item dist\* -Force
187
+ ```
188
+
189
+ 5. **Build the package:**
190
+ ```bash
191
+ python -m build
192
+ ```
193
+ This creates a `dist/` directory with `.whl` and `.tar.gz` files.
194
+
195
+ 6. **(Recommended) Set up a `.pypirc` file for easy publishing:**
196
+ - Create a file named `.pypirc` in your home directory (e.g., `C:\Users\yourname\.pypirc` on Windows or `~/.pypirc` on Linux/macOS).
197
+ - Add:
198
+ ```ini
199
+ [distutils]
200
+ index-servers =
201
+ pypi
202
+
203
+ [pypi]
204
+ username = __token__
205
+ password = pypi-AgEIcH... # <-- paste your API token here
206
+ ```
207
+
208
+ 7. **Publish to PyPI:**
209
+ ```bash
210
+ twine upload dist/*
211
+ ```
212
+ - If you set up `.pypirc`, you won't be prompted for credentials.
213
+ - If not, enter `__token__` as the username and paste your API token as the password.
214
+
215
+ 8. **Verify:**
216
+ - Visit https://pypi.org/project/cyberdesk/ to see your published package.
217
+ - Try installing it in a fresh environment:
218
+ ```bash
219
+ pip install cyberdesk
220
+ ```
221
+
222
+ ---
223
+
224
+ ## License
225
+
226
+ [MIT](LICENSE)
@@ -0,0 +1,9 @@
1
+ cyberdesk/__init__.py,sha256=y9_g5NSt6hLmLsYLZuueIrRdQ_iT4EcAbbYwxPrjaHg,196
2
+ cyberdesk/actions.py,sha256=O8AV9hsPMvhSn2qZHaSuGfjMaAJeLoHdnd10LT_4_Ws,2069
3
+ cyberdesk/client.py,sha256=kxtkdh7AjNuXU8u2rAGhHQTuUKRLyXvX_h7jtdgLzrk,3807
4
+ cyberdesk/types.py,sha256=5jJSShzk3G8DqT0uRc8NFMlSru46tP9q3KJXcZhNRhc,1975
5
+ cyberdesk-0.2.3.dist-info/licenses/LICENSE,sha256=06Op63FCwGhuUOz__M8IZW5sxd29WxyGC4X5-Uih7IQ,1071
6
+ cyberdesk-0.2.3.dist-info/METADATA,sha256=9YWB0wG433HXaHeKbr7iWIeRd48Ts-t_BbZZ7zbEi8U,6435
7
+ cyberdesk-0.2.3.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
8
+ cyberdesk-0.2.3.dist-info/top_level.txt,sha256=CdS7JHYf_tUvJj-XyQ0reLcOLsfrzCFxWQS1apfMkGM,10
9
+ cyberdesk-0.2.3.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (80.3.1)
2
+ Generator: setuptools (80.4.0)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2024 Cyberdesk Team
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Cyberdesk Team
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
@@ -1,137 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: cyberdesk
3
- Version: 0.2.1
4
- Summary: The official Python SDK for Cyberdesk
5
- Author-email: Cyberdesk Team <dev@cyberdesk.io>
6
- License-Expression: MIT
7
- Description-Content-Type: text/markdown
8
- License-File: LICENSE
9
- Requires-Dist: httpx
10
- Provides-Extra: dev
11
- Requires-Dist: openapi-python-client; extra == "dev"
12
- Requires-Dist: build; extra == "dev"
13
- Requires-Dist: twine; extra == "dev"
14
- Dynamic: license-file
15
-
16
- # cyberdesk
17
-
18
- [![PyPI version](https://badge.fury.io/py/cyberdesk.svg)](https://badge.fury.io/py/cyberdesk)
19
-
20
- The official Python SDK for Cyberdesk.
21
-
22
- ## Installation
23
-
24
- ```bash
25
- pip install cyberdesk
26
- ```
27
-
28
- ## Usage
29
-
30
- First, create a Cyberdesk client instance with your API key:
31
-
32
- ```python
33
- from cyberdesk import CyberdeskClient
34
-
35
- client = CyberdeskClient(api_key="YOUR_API_KEY")
36
- ```
37
-
38
- ---
39
-
40
- ### Launch a Desktop
41
-
42
- ```python
43
- result = client.launch_desktop(timeout_ms=10000) # Optional: set a timeout for the desktop session
44
-
45
- # Error handling example
46
- if hasattr(result, 'error') and result.error:
47
- raise Exception('Failed to launch desktop: ' + str(result.error))
48
-
49
- # Success
50
- if hasattr(result, 'id'):
51
- desktop_id = result.id
52
- print('Launched desktop with ID:', desktop_id)
53
- ```
54
-
55
- ---
56
-
57
- ### Get Desktop Info
58
-
59
- ```python
60
- info = client.get_desktop("your-desktop-id")
61
-
62
- if hasattr(info, 'error') and info.error:
63
- raise Exception('Failed to get desktop info: ' + str(info.error))
64
-
65
- print('Desktop info:', info)
66
- ```
67
-
68
- ---
69
-
70
- ### Perform a Computer Action (e.g., Mouse Click)
71
-
72
- ```python
73
- action_result = client.execute_computer_action(
74
- "your-desktop-id",
75
- {
76
- "type": "click_mouse",
77
- "x": 100,
78
- "y": 150
79
- }
80
- )
81
-
82
- if hasattr(action_result, 'error') and action_result.error:
83
- raise Exception('Action failed: ' + str(action_result.error))
84
-
85
- print('Action result:', action_result)
86
- ```
87
-
88
- ---
89
-
90
- ### Run a Bash Command
91
-
92
- ```python
93
- bash_result = client.execute_bash_action(
94
- "your-desktop-id",
95
- "echo Hello, world!"
96
- )
97
-
98
- if hasattr(bash_result, 'error') and bash_result.error:
99
- raise Exception('Bash command failed: ' + str(bash_result.error))
100
-
101
- print('Bash output:', getattr(bash_result, 'output', bash_result))
102
- ```
103
-
104
- ---
105
-
106
- ## Async Usage
107
-
108
- All methods are also available as async variants (prefixed with `async_`). Example:
109
-
110
- ```python
111
- import asyncio
112
- from cyberdesk import CyberdeskClient
113
-
114
- async def main():
115
- client = CyberdeskClient(api_key="YOUR_API_KEY")
116
- result = await client.async_launch_desktop(timeout_ms=10000)
117
- print(result)
118
- # ... use other async_ methods as needed
119
-
120
- asyncio.run(main())
121
- ```
122
-
123
- ---
124
-
125
- ## Type Hints and Models
126
-
127
- All request/response types are available from the generated models:
128
-
129
- ```python
130
- from openapi_client.api_reference_client.models import PostV1DesktopBody, PostV1DesktopIdBashActionBody
131
- ```
132
-
133
- ---
134
-
135
- ## License
136
-
137
- [MIT](LICENSE)
@@ -1,7 +0,0 @@
1
- cyberdesk/__init__.py,sha256=G5ewrCDKWu9oCVWHvpeEB4YqKrnqzvf9ZJlCTtAedBA,36
2
- cyberdesk/client.py,sha256=Hc5Z47cPAYCWcMBi0Ye53zkJ8YumP5wI9z5PQq-yAG8,5818
3
- cyberdesk-0.2.1.dist-info/licenses/LICENSE,sha256=2KwiXv5ggnOI_pTkar6DJhkvlsThyfiA1-Q-CKTYP3U,1091
4
- cyberdesk-0.2.1.dist-info/METADATA,sha256=XgmkoXBOmHxjQWnEmSJt2N_yQ14BSucvlE8AdMr19xY,2933
5
- cyberdesk-0.2.1.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
6
- cyberdesk-0.2.1.dist-info/top_level.txt,sha256=CdS7JHYf_tUvJj-XyQ0reLcOLsfrzCFxWQS1apfMkGM,10
7
- cyberdesk-0.2.1.dist-info/RECORD,,