cyberdesk 0.2.2__tar.gz → 0.2.3__tar.gz
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-0.2.2 → cyberdesk-0.2.3}/LICENSE +20 -20
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/PKG-INFO +15 -5
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/README.md +209 -200
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/cyberdesk/__init__.py +7 -7
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/cyberdesk/actions.py +37 -37
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/cyberdesk/client.py +74 -74
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/cyberdesk/types.py +49 -49
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/cyberdesk.egg-info/PKG-INFO +15 -5
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/cyberdesk.egg-info/requires.txt +1 -0
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/pyproject.toml +24 -23
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/cyberdesk.egg-info/SOURCES.txt +0 -0
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/cyberdesk.egg-info/dependency_links.txt +0 -0
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/cyberdesk.egg-info/top_level.txt +0 -0
- {cyberdesk-0.2.2 → cyberdesk-0.2.3}/setup.cfg +0 -0
|
@@ -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,12 +1,13 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: cyberdesk
|
|
3
|
-
Version: 0.2.
|
|
3
|
+
Version: 0.2.3
|
|
4
4
|
Summary: The official Python SDK for Cyberdesk
|
|
5
5
|
Author-email: Cyberdesk Team <dev@cyberdesk.io>
|
|
6
6
|
License-Expression: MIT
|
|
7
7
|
Description-Content-Type: text/markdown
|
|
8
8
|
License-File: LICENSE
|
|
9
9
|
Requires-Dist: httpx
|
|
10
|
+
Requires-Dist: openapi_client
|
|
10
11
|
Provides-Extra: dev
|
|
11
12
|
Requires-Dist: openapi-python-client; extra == "dev"
|
|
12
13
|
Requires-Dist: build; extra == "dev"
|
|
@@ -176,13 +177,22 @@ To build and publish this package to [PyPI](https://pypi.org/project/cyberdesk/)
|
|
|
176
177
|
uv pip install .[dev]
|
|
177
178
|
```
|
|
178
179
|
|
|
179
|
-
3. **
|
|
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:**
|
|
180
190
|
```bash
|
|
181
191
|
python -m build
|
|
182
192
|
```
|
|
183
193
|
This creates a `dist/` directory with `.whl` and `.tar.gz` files.
|
|
184
194
|
|
|
185
|
-
|
|
195
|
+
6. **(Recommended) Set up a `.pypirc` file for easy publishing:**
|
|
186
196
|
- Create a file named `.pypirc` in your home directory (e.g., `C:\Users\yourname\.pypirc` on Windows or `~/.pypirc` on Linux/macOS).
|
|
187
197
|
- Add:
|
|
188
198
|
```ini
|
|
@@ -195,14 +205,14 @@ To build and publish this package to [PyPI](https://pypi.org/project/cyberdesk/)
|
|
|
195
205
|
password = pypi-AgEIcH... # <-- paste your API token here
|
|
196
206
|
```
|
|
197
207
|
|
|
198
|
-
|
|
208
|
+
7. **Publish to PyPI:**
|
|
199
209
|
```bash
|
|
200
210
|
twine upload dist/*
|
|
201
211
|
```
|
|
202
212
|
- If you set up `.pypirc`, you won't be prompted for credentials.
|
|
203
213
|
- If not, enter `__token__` as the username and paste your API token as the password.
|
|
204
214
|
|
|
205
|
-
|
|
215
|
+
8. **Verify:**
|
|
206
216
|
- Visit https://pypi.org/project/cyberdesk/ to see your published package.
|
|
207
217
|
- Try installing it in a fresh environment:
|
|
208
218
|
```bash
|
|
@@ -1,201 +1,210 @@
|
|
|
1
|
-
# cyberdesk
|
|
2
|
-
|
|
3
|
-
[](https://badge.fury.io/py/cyberdesk)
|
|
4
|
-
|
|
5
|
-
The official Python SDK for Cyberdesk.
|
|
6
|
-
|
|
7
|
-
## Installation
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
pip install cyberdesk
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Usage
|
|
14
|
-
|
|
15
|
-
First, create a Cyberdesk client instance with your API key:
|
|
16
|
-
|
|
17
|
-
```python
|
|
18
|
-
from cyberdesk import CyberdeskClient
|
|
19
|
-
|
|
20
|
-
client = CyberdeskClient(api_key="YOUR_API_KEY")
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### Launch a Desktop
|
|
26
|
-
|
|
27
|
-
```python
|
|
28
|
-
result = client.launch_desktop(timeout_ms=10000) # Optional: set a timeout for the desktop session
|
|
29
|
-
|
|
30
|
-
# Error handling example
|
|
31
|
-
if hasattr(result, 'error') and result.error:
|
|
32
|
-
raise Exception('Failed to launch desktop: ' + str(result.error))
|
|
33
|
-
|
|
34
|
-
# Success
|
|
35
|
-
if hasattr(result, 'id'):
|
|
36
|
-
desktop_id = result.id
|
|
37
|
-
print('Launched desktop with ID:', desktop_id)
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
---
|
|
41
|
-
|
|
42
|
-
### Get Desktop Info
|
|
43
|
-
|
|
44
|
-
```python
|
|
45
|
-
info = client.get_desktop("your-desktop-id")
|
|
46
|
-
|
|
47
|
-
if hasattr(info, 'error') and info.error:
|
|
48
|
-
raise Exception('Failed to get desktop info: ' + str(info.error))
|
|
49
|
-
|
|
50
|
-
print('Desktop info:', info)
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
### Perform a Computer Action (e.g., Mouse Click)
|
|
56
|
-
|
|
57
|
-
```python
|
|
58
|
-
from cyberdesk.actions import click_mouse
|
|
59
|
-
|
|
60
|
-
action = click_mouse(x=100, y=150, button="left")
|
|
61
|
-
action_result = client.execute_computer_action("your-desktop-id", action)
|
|
62
|
-
|
|
63
|
-
if hasattr(action_result, 'error') and action_result.error:
|
|
64
|
-
raise Exception('Action failed: ' + str(action_result.error))
|
|
65
|
-
|
|
66
|
-
print('Action result:', action_result)
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
### Run a Bash Command
|
|
72
|
-
|
|
73
|
-
```python
|
|
74
|
-
bash_result = client.execute_bash_action(
|
|
75
|
-
"your-desktop-id",
|
|
76
|
-
"echo Hello, world!"
|
|
77
|
-
)
|
|
78
|
-
|
|
79
|
-
if hasattr(bash_result, 'error') and bash_result.error:
|
|
80
|
-
raise Exception('Bash command failed: ' + str(bash_result.error))
|
|
81
|
-
|
|
82
|
-
print('Bash output:', getattr(bash_result, 'output', bash_result))
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
## Ergonomic, Type-Safe Actions
|
|
88
|
-
|
|
89
|
-
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.
|
|
90
|
-
|
|
91
|
-
**Example:**
|
|
92
|
-
```python
|
|
93
|
-
from cyberdesk.actions import click_mouse, type_text
|
|
94
|
-
|
|
95
|
-
action1 = click_mouse(x=100, y=200, button="left")
|
|
96
|
-
action2 = type_text(text="Hello, world!")
|
|
97
|
-
|
|
98
|
-
client.execute_computer_action("your-desktop-id", action1)
|
|
99
|
-
client.execute_computer_action("your-desktop-id", action2)
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
| Action | Factory Function | Description |
|
|
103
|
-
|----------------|-------------------------|----------------------------|
|
|
104
|
-
| Click Mouse | `click_mouse` | Mouse click at (x, y) |
|
|
105
|
-
| Drag Mouse | `drag_mouse` | Mouse drag from/to (x, y) |
|
|
106
|
-
| Move Mouse | `move_mouse` | Move mouse to (x, y) |
|
|
107
|
-
| Scroll | `scroll` | Scroll by dx, dy |
|
|
108
|
-
| Type Text | `type_text` | Type text |
|
|
109
|
-
| Press Keys | `press_keys` | Press keyboard keys |
|
|
110
|
-
| Screenshot | `screenshot` | Take a screenshot |
|
|
111
|
-
| Wait | `wait` | Wait for ms milliseconds |
|
|
112
|
-
| Get Cursor Pos | `get_cursor_position` | Get mouse cursor position |
|
|
113
|
-
|
|
114
|
-
---
|
|
115
|
-
|
|
116
|
-
## Async Usage
|
|
117
|
-
|
|
118
|
-
All methods are also available as async variants (prefixed with `async_`). Example:
|
|
119
|
-
|
|
120
|
-
```python
|
|
121
|
-
import asyncio
|
|
122
|
-
from cyberdesk import CyberdeskClient
|
|
123
|
-
from cyberdesk.actions import click_mouse
|
|
124
|
-
|
|
125
|
-
async def main():
|
|
126
|
-
client = CyberdeskClient(api_key="YOUR_API_KEY")
|
|
127
|
-
result = await client.async_launch_desktop(timeout_ms=10000)
|
|
128
|
-
print(result)
|
|
129
|
-
# Example async computer action
|
|
130
|
-
action = click_mouse(x=100, y=200)
|
|
131
|
-
await client.async_execute_computer_action("your-desktop-id", action)
|
|
132
|
-
# ... use other async_ methods as needed
|
|
133
|
-
|
|
134
|
-
asyncio.run(main())
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
---
|
|
138
|
-
|
|
139
|
-
## Type Hints and Models
|
|
140
|
-
|
|
141
|
-
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.
|
|
142
|
-
|
|
143
|
-
```python
|
|
144
|
-
from cyberdesk.actions import click_mouse, drag_mouse, type_text, wait, scroll, move_mouse, press_keys, screenshot, get_cursor_position
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
|
-
## For Cyberdesk Team: Publishing to PyPI
|
|
150
|
-
|
|
151
|
-
**Recommended:** Always use a [virtual environment](https://docs.python.org/3/library/venv.html) (venv) for building and publishing to avoid dependency conflicts.
|
|
152
|
-
|
|
153
|
-
To build and publish this package to [PyPI](https://pypi.org/project/cyberdesk/):
|
|
154
|
-
|
|
155
|
-
1. **Log into PyPI** (get credentials from the Cyberdesk team).
|
|
156
|
-
|
|
157
|
-
2. **Install dev dependencies** (in a clean venv):
|
|
158
|
-
```bash
|
|
159
|
-
pip install .[dev]
|
|
160
|
-
# or
|
|
161
|
-
uv pip install .[dev]
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
3. **
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
1
|
+
# cyberdesk
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/py/cyberdesk)
|
|
4
|
+
|
|
5
|
+
The official Python SDK for Cyberdesk.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pip install cyberdesk
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
First, create a Cyberdesk client instance with your API key:
|
|
16
|
+
|
|
17
|
+
```python
|
|
18
|
+
from cyberdesk import CyberdeskClient
|
|
19
|
+
|
|
20
|
+
client = CyberdeskClient(api_key="YOUR_API_KEY")
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
### Launch a Desktop
|
|
26
|
+
|
|
27
|
+
```python
|
|
28
|
+
result = client.launch_desktop(timeout_ms=10000) # Optional: set a timeout for the desktop session
|
|
29
|
+
|
|
30
|
+
# Error handling example
|
|
31
|
+
if hasattr(result, 'error') and result.error:
|
|
32
|
+
raise Exception('Failed to launch desktop: ' + str(result.error))
|
|
33
|
+
|
|
34
|
+
# Success
|
|
35
|
+
if hasattr(result, 'id'):
|
|
36
|
+
desktop_id = result.id
|
|
37
|
+
print('Launched desktop with ID:', desktop_id)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
### Get Desktop Info
|
|
43
|
+
|
|
44
|
+
```python
|
|
45
|
+
info = client.get_desktop("your-desktop-id")
|
|
46
|
+
|
|
47
|
+
if hasattr(info, 'error') and info.error:
|
|
48
|
+
raise Exception('Failed to get desktop info: ' + str(info.error))
|
|
49
|
+
|
|
50
|
+
print('Desktop info:', info)
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
### Perform a Computer Action (e.g., Mouse Click)
|
|
56
|
+
|
|
57
|
+
```python
|
|
58
|
+
from cyberdesk.actions import click_mouse
|
|
59
|
+
|
|
60
|
+
action = click_mouse(x=100, y=150, button="left")
|
|
61
|
+
action_result = client.execute_computer_action("your-desktop-id", action)
|
|
62
|
+
|
|
63
|
+
if hasattr(action_result, 'error') and action_result.error:
|
|
64
|
+
raise Exception('Action failed: ' + str(action_result.error))
|
|
65
|
+
|
|
66
|
+
print('Action result:', action_result)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
### Run a Bash Command
|
|
72
|
+
|
|
73
|
+
```python
|
|
74
|
+
bash_result = client.execute_bash_action(
|
|
75
|
+
"your-desktop-id",
|
|
76
|
+
"echo Hello, world!"
|
|
77
|
+
)
|
|
78
|
+
|
|
79
|
+
if hasattr(bash_result, 'error') and bash_result.error:
|
|
80
|
+
raise Exception('Bash command failed: ' + str(bash_result.error))
|
|
81
|
+
|
|
82
|
+
print('Bash output:', getattr(bash_result, 'output', bash_result))
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Ergonomic, Type-Safe Actions
|
|
88
|
+
|
|
89
|
+
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.
|
|
90
|
+
|
|
91
|
+
**Example:**
|
|
92
|
+
```python
|
|
93
|
+
from cyberdesk.actions import click_mouse, type_text
|
|
94
|
+
|
|
95
|
+
action1 = click_mouse(x=100, y=200, button="left")
|
|
96
|
+
action2 = type_text(text="Hello, world!")
|
|
97
|
+
|
|
98
|
+
client.execute_computer_action("your-desktop-id", action1)
|
|
99
|
+
client.execute_computer_action("your-desktop-id", action2)
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
| Action | Factory Function | Description |
|
|
103
|
+
|----------------|-------------------------|----------------------------|
|
|
104
|
+
| Click Mouse | `click_mouse` | Mouse click at (x, y) |
|
|
105
|
+
| Drag Mouse | `drag_mouse` | Mouse drag from/to (x, y) |
|
|
106
|
+
| Move Mouse | `move_mouse` | Move mouse to (x, y) |
|
|
107
|
+
| Scroll | `scroll` | Scroll by dx, dy |
|
|
108
|
+
| Type Text | `type_text` | Type text |
|
|
109
|
+
| Press Keys | `press_keys` | Press keyboard keys |
|
|
110
|
+
| Screenshot | `screenshot` | Take a screenshot |
|
|
111
|
+
| Wait | `wait` | Wait for ms milliseconds |
|
|
112
|
+
| Get Cursor Pos | `get_cursor_position` | Get mouse cursor position |
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## Async Usage
|
|
117
|
+
|
|
118
|
+
All methods are also available as async variants (prefixed with `async_`). Example:
|
|
119
|
+
|
|
120
|
+
```python
|
|
121
|
+
import asyncio
|
|
122
|
+
from cyberdesk import CyberdeskClient
|
|
123
|
+
from cyberdesk.actions import click_mouse
|
|
124
|
+
|
|
125
|
+
async def main():
|
|
126
|
+
client = CyberdeskClient(api_key="YOUR_API_KEY")
|
|
127
|
+
result = await client.async_launch_desktop(timeout_ms=10000)
|
|
128
|
+
print(result)
|
|
129
|
+
# Example async computer action
|
|
130
|
+
action = click_mouse(x=100, y=200)
|
|
131
|
+
await client.async_execute_computer_action("your-desktop-id", action)
|
|
132
|
+
# ... use other async_ methods as needed
|
|
133
|
+
|
|
134
|
+
asyncio.run(main())
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## Type Hints and Models
|
|
140
|
+
|
|
141
|
+
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.
|
|
142
|
+
|
|
143
|
+
```python
|
|
144
|
+
from cyberdesk.actions import click_mouse, drag_mouse, type_text, wait, scroll, move_mouse, press_keys, screenshot, get_cursor_position
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
## For Cyberdesk Team: Publishing to PyPI
|
|
150
|
+
|
|
151
|
+
**Recommended:** Always use a [virtual environment](https://docs.python.org/3/library/venv.html) (venv) for building and publishing to avoid dependency conflicts.
|
|
152
|
+
|
|
153
|
+
To build and publish this package to [PyPI](https://pypi.org/project/cyberdesk/):
|
|
154
|
+
|
|
155
|
+
1. **Log into PyPI** (get credentials from the Cyberdesk team).
|
|
156
|
+
|
|
157
|
+
2. **Install dev dependencies** (in a clean venv):
|
|
158
|
+
```bash
|
|
159
|
+
pip install .[dev]
|
|
160
|
+
# or
|
|
161
|
+
uv pip install .[dev]
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
3. **Bump the version number** in `pyproject.toml` (e.g., `version = "0.2.4"`).
|
|
165
|
+
|
|
166
|
+
4. **Clean your `dist/` directory** before building to avoid 'File already exists' errors:
|
|
167
|
+
```bash
|
|
168
|
+
rm -rf dist/*
|
|
169
|
+
# On Windows PowerShell:
|
|
170
|
+
Remove-Item dist\* -Force
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
5. **Build the package:**
|
|
174
|
+
```bash
|
|
175
|
+
python -m build
|
|
176
|
+
```
|
|
177
|
+
This creates a `dist/` directory with `.whl` and `.tar.gz` files.
|
|
178
|
+
|
|
179
|
+
6. **(Recommended) Set up a `.pypirc` file for easy publishing:**
|
|
180
|
+
- Create a file named `.pypirc` in your home directory (e.g., `C:\Users\yourname\.pypirc` on Windows or `~/.pypirc` on Linux/macOS).
|
|
181
|
+
- Add:
|
|
182
|
+
```ini
|
|
183
|
+
[distutils]
|
|
184
|
+
index-servers =
|
|
185
|
+
pypi
|
|
186
|
+
|
|
187
|
+
[pypi]
|
|
188
|
+
username = __token__
|
|
189
|
+
password = pypi-AgEIcH... # <-- paste your API token here
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
7. **Publish to PyPI:**
|
|
193
|
+
```bash
|
|
194
|
+
twine upload dist/*
|
|
195
|
+
```
|
|
196
|
+
- If you set up `.pypirc`, you won't be prompted for credentials.
|
|
197
|
+
- If not, enter `__token__` as the username and paste your API token as the password.
|
|
198
|
+
|
|
199
|
+
8. **Verify:**
|
|
200
|
+
- Visit https://pypi.org/project/cyberdesk/ to see your published package.
|
|
201
|
+
- Try installing it in a fresh environment:
|
|
202
|
+
```bash
|
|
203
|
+
pip install cyberdesk
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
|
+
## License
|
|
209
|
+
|
|
201
210
|
[MIT](LICENSE)
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
from .client import CyberdeskClient
|
|
2
|
-
from .types import (
|
|
3
|
-
GetDesktopParams,
|
|
4
|
-
LaunchDesktopParams,
|
|
5
|
-
TerminateDesktopParams,
|
|
6
|
-
ExecuteComputerActionParams,
|
|
7
|
-
ExecuteBashActionParams,
|
|
1
|
+
from .client import CyberdeskClient
|
|
2
|
+
from .types import (
|
|
3
|
+
GetDesktopParams,
|
|
4
|
+
LaunchDesktopParams,
|
|
5
|
+
TerminateDesktopParams,
|
|
6
|
+
ExecuteComputerActionParams,
|
|
7
|
+
ExecuteBashActionParams,
|
|
8
8
|
)
|
|
@@ -1,38 +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:
|
|
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
38
|
return PostV1DesktopIdComputerActionWaitAction(type="wait", ms=ms)
|
|
@@ -1,75 +1,75 @@
|
|
|
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)
|
|
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)
|
|
75
75
|
return await post_v1_desktop_id_bash_action.asyncio(id=id, client=self.client, body=body, x_api_key=self.api_key)
|
|
@@ -1,50 +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",
|
|
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
50
|
]
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: cyberdesk
|
|
3
|
-
Version: 0.2.
|
|
3
|
+
Version: 0.2.3
|
|
4
4
|
Summary: The official Python SDK for Cyberdesk
|
|
5
5
|
Author-email: Cyberdesk Team <dev@cyberdesk.io>
|
|
6
6
|
License-Expression: MIT
|
|
7
7
|
Description-Content-Type: text/markdown
|
|
8
8
|
License-File: LICENSE
|
|
9
9
|
Requires-Dist: httpx
|
|
10
|
+
Requires-Dist: openapi_client
|
|
10
11
|
Provides-Extra: dev
|
|
11
12
|
Requires-Dist: openapi-python-client; extra == "dev"
|
|
12
13
|
Requires-Dist: build; extra == "dev"
|
|
@@ -176,13 +177,22 @@ To build and publish this package to [PyPI](https://pypi.org/project/cyberdesk/)
|
|
|
176
177
|
uv pip install .[dev]
|
|
177
178
|
```
|
|
178
179
|
|
|
179
|
-
3. **
|
|
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:**
|
|
180
190
|
```bash
|
|
181
191
|
python -m build
|
|
182
192
|
```
|
|
183
193
|
This creates a `dist/` directory with `.whl` and `.tar.gz` files.
|
|
184
194
|
|
|
185
|
-
|
|
195
|
+
6. **(Recommended) Set up a `.pypirc` file for easy publishing:**
|
|
186
196
|
- Create a file named `.pypirc` in your home directory (e.g., `C:\Users\yourname\.pypirc` on Windows or `~/.pypirc` on Linux/macOS).
|
|
187
197
|
- Add:
|
|
188
198
|
```ini
|
|
@@ -195,14 +205,14 @@ To build and publish this package to [PyPI](https://pypi.org/project/cyberdesk/)
|
|
|
195
205
|
password = pypi-AgEIcH... # <-- paste your API token here
|
|
196
206
|
```
|
|
197
207
|
|
|
198
|
-
|
|
208
|
+
7. **Publish to PyPI:**
|
|
199
209
|
```bash
|
|
200
210
|
twine upload dist/*
|
|
201
211
|
```
|
|
202
212
|
- If you set up `.pypirc`, you won't be prompted for credentials.
|
|
203
213
|
- If not, enter `__token__` as the username and paste your API token as the password.
|
|
204
214
|
|
|
205
|
-
|
|
215
|
+
8. **Verify:**
|
|
206
216
|
- Visit https://pypi.org/project/cyberdesk/ to see your published package.
|
|
207
217
|
- Try installing it in a fresh environment:
|
|
208
218
|
```bash
|
|
@@ -1,24 +1,25 @@
|
|
|
1
|
-
[project]
|
|
2
|
-
name = "cyberdesk"
|
|
3
|
-
version = "0.2.
|
|
4
|
-
description = "The official Python SDK for Cyberdesk"
|
|
5
|
-
authors = [{name = "Cyberdesk Team", email = "dev@cyberdesk.io"}]
|
|
6
|
-
readme = "README.md"
|
|
7
|
-
license = "MIT"
|
|
8
|
-
dependencies = [
|
|
9
|
-
"httpx"
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
1
|
+
[project]
|
|
2
|
+
name = "cyberdesk"
|
|
3
|
+
version = "0.2.3"
|
|
4
|
+
description = "The official Python SDK for Cyberdesk"
|
|
5
|
+
authors = [{name = "Cyberdesk Team", email = "dev@cyberdesk.io"}]
|
|
6
|
+
readme = "README.md"
|
|
7
|
+
license = "MIT"
|
|
8
|
+
dependencies = [
|
|
9
|
+
"httpx",
|
|
10
|
+
"openapi_client"
|
|
11
|
+
]
|
|
12
|
+
|
|
13
|
+
[build-system]
|
|
14
|
+
requires = ["setuptools", "wheel"]
|
|
15
|
+
build-backend = "setuptools.build_meta"
|
|
16
|
+
|
|
17
|
+
[project.optional-dependencies]
|
|
18
|
+
dev = [
|
|
19
|
+
"openapi-python-client",
|
|
20
|
+
"build",
|
|
21
|
+
"twine"
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
[tool.setuptools.packages.find]
|
|
24
25
|
include = ["cyberdesk*"]
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|