Skip to content

Commit c5663e6

Browse files
committed
reorganize structure + add relevant base api types
1 parent e8d1053 commit c5663e6

4 files changed

Lines changed: 134 additions & 153 deletions

File tree

docs/api/index.rst

Lines changed: 0 additions & 135 deletions
This file was deleted.

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ and asynchronous variants to match your runtime requirements.
99
:maxdepth: 2
1010
:caption: Contents:
1111

12-
api/index
12+
sdk/index
1313

1414
Installation
1515
------------
@@ -42,6 +42,7 @@ Asynchronous Example
4242

4343
.. code-block:: python
4444
45+
import asyncio
4546
from runloop_api_client import AsyncRunloopSDK
4647
4748
async def main():
@@ -51,7 +52,6 @@ Asynchronous Example
5152
result = await devbox.cmd.exec(command="echo 'Hello from Runloop!'")
5253
print(await result.stdout())
5354
54-
import asyncio
5555
asyncio.run(main())
5656
5757
Indices and tables

docs/sdk/index.rst

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
SDK Reference
2+
=============
3+
4+
This section contains detailed documentation for the Runloop SDK.
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
types
10+
11+
Synchronous SDK
12+
---------------
13+
14+
Core Module
15+
~~~~~~~~~~~
16+
17+
The core synchronous SDK module provides the main entry point and operation classes.
18+
19+
.. automodule:: runloop_api_client.sdk.sync
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
Resource Modules
25+
~~~~~~~~~~~~~~~~
26+
27+
Synchronous resource classes for working with devboxes, blueprints, snapshots, and more.
28+
29+
.. automodule:: runloop_api_client.sdk.devbox
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:
33+
34+
.. automodule:: runloop_api_client.sdk.blueprint
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
.. automodule:: runloop_api_client.sdk.snapshot
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
.. automodule:: runloop_api_client.sdk.storage_object
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
.. automodule:: runloop_api_client.sdk.execution
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+
54+
.. automodule:: runloop_api_client.sdk.execution_result
55+
:members:
56+
:undoc-members:
57+
:show-inheritance:
58+
59+
Asynchronous SDK
60+
----------------
61+
62+
Core Module
63+
~~~~~~~~~~~
64+
65+
The core asynchronous SDK module provides async operation classes.
66+
67+
.. automodule:: runloop_api_client.sdk.async_
68+
:members:
69+
:undoc-members:
70+
:show-inheritance:
71+
72+
Resource Modules
73+
~~~~~~~~~~~~~~~~
74+
75+
Asynchronous resource classes for working with devboxes, blueprints, snapshots, and more.
76+
77+
.. automodule:: runloop_api_client.sdk.async_devbox
78+
:members:
79+
:undoc-members:
80+
:show-inheritance:
81+
82+
.. automodule:: runloop_api_client.sdk.async_blueprint
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
.. automodule:: runloop_api_client.sdk.async_snapshot
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
.. automodule:: runloop_api_client.sdk.async_storage_object
93+
:members:
94+
:undoc-members:
95+
:show-inheritance:
96+
97+
.. automodule:: runloop_api_client.sdk.async_execution
98+
:members:
99+
:undoc-members:
100+
:show-inheritance:
101+
102+
.. automodule:: runloop_api_client.sdk.async_execution_result
103+
:members:
104+
:undoc-members:
105+
:show-inheritance:
106+
Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
1-
TypedDict Reference
2-
===================
1+
Type Reference
2+
==============
33

4-
This page documents all TypedDict parameter types used throughout the SDK.
5-
These typed dictionaries define the structure of parameters passed to SDK methods.
6-
7-
SDK TypedDicts
8-
--------------
9-
10-
These are the primary TypedDict classes used in SDK methods, combining multiple
11-
parameter types and options.
4+
This page documents all TypeDict parameter types used throughout the SDK.
125

136
Core Request Options
14-
~~~~~~~~~~~~~~~~~~~~
7+
--------------------
8+
9+
These TypeDicts define options for streaming, timeouts, polling, and other request configuration.
1510

1611
.. autotypeddict:: runloop_api_client.sdk._types.ExecuteStreamingCallbacks
1712

@@ -24,16 +19,27 @@ Core Request Options
2419
.. autotypeddict:: runloop_api_client.sdk._types.LongPollingRequestOptions
2520

2621
Devbox Parameters
27-
~~~~~~~~~~~~~~~~~
22+
-----------------
23+
24+
These TypeDicts define parameters for devbox creation, execution, file operations, network tunnels, and snapshots.
25+
26+
Creation Parameters
27+
~~~~~~~~~~~~~~~~~~~
2828

2929
.. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxCreateParams
3030

3131
.. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxExtraCreateParams
3232

33+
Execution Parameters
34+
~~~~~~~~~~~~~~~~~~~~
35+
3336
.. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxExecuteParams
3437

3538
.. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxExecuteAsyncParams
3639

40+
Listing Parameters
41+
~~~~~~~~~~~~~~~~~~
42+
3743
.. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxListParams
3844

3945
File Operation Parameters
@@ -47,8 +53,8 @@ File Operation Parameters
4753

4854
.. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxUploadFileParams
4955

50-
Network Operation Parameters
51-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56+
Network Tunnel Parameters
57+
~~~~~~~~~~~~~~~~~~~~~~~~~~
5258

5359
.. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxCreateTunnelParams
5460

@@ -66,14 +72,18 @@ Snapshot Parameters
6672
.. autotypeddict:: runloop_api_client.sdk._types.SDKDiskSnapshotUpdateParams
6773

6874
Blueprint Parameters
69-
~~~~~~~~~~~~~~~~~~~~
75+
--------------------
76+
77+
These TypeDicts define parameters for blueprint creation and listing.
7078

7179
.. autotypeddict:: runloop_api_client.sdk._types.SDKBlueprintCreateParams
7280

7381
.. autotypeddict:: runloop_api_client.sdk._types.SDKBlueprintListParams
7482

7583
Storage Object Parameters
76-
~~~~~~~~~~~~~~~~~~~~~~~~~
84+
-------------------------
85+
86+
These TypeDicts define parameters for storage object creation, listing, and downloading.
7787

7888
.. autotypeddict:: runloop_api_client.sdk._types.SDKObjectCreateParams
7989

0 commit comments

Comments
 (0)