diff --git a/docs/api/agent.rst b/docs/api/agent.rst new file mode 100644 index 000000000..465b6f66b --- /dev/null +++ b/docs/api/agent.rst @@ -0,0 +1,16 @@ +Agent +===== + +The ``Agent`` class represents an agent resource in the Runloop platform. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_agent + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.agent + :members: diff --git a/docs/api/axon.rst b/docs/api/axon.rst new file mode 100644 index 000000000..c47da18c9 --- /dev/null +++ b/docs/api/axon.rst @@ -0,0 +1,21 @@ +Axon +==== + +.. note:: + + Axon APIs are in beta and may change. + +The ``Axon`` class provides event communication channels with support for +publish/subscribe messaging, server-sent events (SSE) streaming, and SQL operations. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_axon + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.axon + :members: diff --git a/docs/api/benchmark.rst b/docs/api/benchmark.rst new file mode 100644 index 000000000..4ad8fe9c3 --- /dev/null +++ b/docs/api/benchmark.rst @@ -0,0 +1,18 @@ +Benchmark +========= + +The ``Benchmark`` class manages benchmarks that group multiple scenarios for +systematic evaluation. Use benchmarks to run and compare agent performance +across a suite of scenarios. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_benchmark + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.benchmark + :members: diff --git a/docs/api/benchmark_run.rst b/docs/api/benchmark_run.rst new file mode 100644 index 000000000..a1143cda9 --- /dev/null +++ b/docs/api/benchmark_run.rst @@ -0,0 +1,17 @@ +Benchmark Run +============= + +The ``BenchmarkRun`` class represents a running instance of a benchmark. +Use it to track progress, list scenario runs, and manage the benchmark lifecycle. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_benchmark_run + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.benchmark_run + :members: diff --git a/docs/api/blueprint.rst b/docs/api/blueprint.rst new file mode 100644 index 000000000..561a2d948 --- /dev/null +++ b/docs/api/blueprint.rst @@ -0,0 +1,17 @@ +Blueprint +========= + +The ``Blueprint`` class represents a reusable devbox configuration built from a Dockerfile +and optional setup commands. Use blueprints to create pre-configured devbox environments. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_blueprint + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.blueprint + :members: diff --git a/docs/api/core.rst b/docs/api/core.rst new file mode 100644 index 000000000..0121648ea --- /dev/null +++ b/docs/api/core.rst @@ -0,0 +1,33 @@ +Core Module +=========== + +The core module provides the main SDK entry points and operation manager classes. +Use :class:`~runloop_api_client.sdk.async_.AsyncRunloopSDK` for async/await code or +:class:`~runloop_api_client.sdk.sync.RunloopSDK` for synchronous code. + +Asynchronous API +---------------- + +.. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK + +.. automodule:: runloop_api_client.sdk.async_ + +Synchronous API +--------------- + +.. autoclass:: runloop_api_client.sdk.sync.RunloopSDK + +.. automodule:: runloop_api_client.sdk.sync + +Base REST Client +---------------- + +The SDK wraps the generated REST client. The ``api`` attribute on +:class:`~runloop_api_client.sdk.async_.AsyncRunloopSDK` / +:class:`~runloop_api_client.sdk.sync.RunloopSDK` provides direct access. + +.. autoclass:: runloop_api_client.AsyncRunloop + :no-members: + +.. autoclass:: runloop_api_client.Runloop + :no-members: diff --git a/docs/api/devbox.rst b/docs/api/devbox.rst new file mode 100644 index 000000000..b38dcd6e3 --- /dev/null +++ b/docs/api/devbox.rst @@ -0,0 +1,18 @@ +Devbox +====== + +The ``Devbox`` class provides methods for managing and interacting with a devbox instance, +including command execution, file operations, networking, and lifecycle management. +Devboxes support context manager usage for automatic cleanup. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_devbox + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.devbox + :members: diff --git a/docs/api/execution.rst b/docs/api/execution.rst new file mode 100644 index 000000000..a788f5e82 --- /dev/null +++ b/docs/api/execution.rst @@ -0,0 +1,17 @@ +Execution +========= + +The ``Execution`` class represents an in-progress asynchronous command execution on a devbox. +Use it to track, wait for, or cancel long-running commands started with ``exec_async()``. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_execution + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.execution + :members: diff --git a/docs/api/execution_result.rst b/docs/api/execution_result.rst new file mode 100644 index 000000000..36a230c2e --- /dev/null +++ b/docs/api/execution_result.rst @@ -0,0 +1,17 @@ +Execution Result +================ + +The ``ExecutionResult`` class wraps the output of a completed command execution, +providing access to stdout, stderr, exit codes, and output parsing utilities. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_execution_result + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.execution_result + :members: diff --git a/docs/api/gateway_config.rst b/docs/api/gateway_config.rst new file mode 100644 index 000000000..75600378b --- /dev/null +++ b/docs/api/gateway_config.rst @@ -0,0 +1,17 @@ +Gateway Config +============== + +The ``GatewayConfig`` class manages API gateway configurations that proxy +requests through devboxes with credential management and authentication. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_gateway_config + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.gateway_config + :members: diff --git a/docs/api/index.rst b/docs/api/index.rst new file mode 100644 index 000000000..ae4cf429c --- /dev/null +++ b/docs/api/index.rst @@ -0,0 +1,51 @@ +API Reference +============= + +The Runloop Python SDK provides both synchronous and asynchronous variants for every resource. +Each page below documents both variants together. The async API mirrors the sync API exactly, +with ``await`` required on all methods. + +.. toctree:: + :maxdepth: 1 + :caption: Compute & Execution + + core + devbox + execution + execution_result + blueprint + snapshot + storage_object + +.. toctree:: + :maxdepth: 1 + :caption: Agents & Evaluation + + agent + scorer + scenario + scenario_builder + scenario_run + benchmark + benchmark_run + +.. toctree:: + :maxdepth: 1 + :caption: Communication + + axon + +.. toctree:: + :maxdepth: 1 + :caption: Security & Configuration + + secret + mcp_config + gateway_config + network_policy + +.. toctree:: + :maxdepth: 1 + :caption: Type Reference + + types diff --git a/docs/api/mcp_config.rst b/docs/api/mcp_config.rst new file mode 100644 index 000000000..000101aa0 --- /dev/null +++ b/docs/api/mcp_config.rst @@ -0,0 +1,17 @@ +MCP Config +========== + +The ``McpConfig`` class manages Model Context Protocol (MCP) server configurations +that can be attached to devboxes, defining which MCP servers and tools are available. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_mcp_config + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.mcp_config + :members: diff --git a/docs/api/network_policy.rst b/docs/api/network_policy.rst new file mode 100644 index 000000000..d98c755b5 --- /dev/null +++ b/docs/api/network_policy.rst @@ -0,0 +1,17 @@ +Network Policy +============== + +The ``NetworkPolicy`` class manages network access policies for devboxes, +controlling which hostnames and services a devbox can communicate with. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_network_policy + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.network_policy + :members: diff --git a/docs/api/scenario.rst b/docs/api/scenario.rst new file mode 100644 index 000000000..d6053d48c --- /dev/null +++ b/docs/api/scenario.rst @@ -0,0 +1,17 @@ +Scenario +======== + +The ``Scenario`` class represents a scenario for evaluating agent performance. +Scenarios define environments, problem statements, and scoring criteria. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_scenario + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.scenario + :members: diff --git a/docs/api/scenario_builder.rst b/docs/api/scenario_builder.rst new file mode 100644 index 000000000..3bf0efeb0 --- /dev/null +++ b/docs/api/scenario_builder.rst @@ -0,0 +1,18 @@ +Scenario Builder +================ + +The ``ScenarioBuilder`` class provides a fluent API for constructing scenarios. +Chain methods to configure the environment, problem statement, and scoring criteria +before building or pushing the scenario. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_scenario_builder + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.scenario_builder + :members: diff --git a/docs/api/scenario_run.rst b/docs/api/scenario_run.rst new file mode 100644 index 000000000..3b3d98f76 --- /dev/null +++ b/docs/api/scenario_run.rst @@ -0,0 +1,17 @@ +Scenario Run +============ + +The ``ScenarioRun`` class represents a running instance of a scenario. +Use it to manage the run lifecycle, retrieve scores, and download logs. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_scenario_run + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.scenario_run + :members: diff --git a/docs/api/scorer.rst b/docs/api/scorer.rst new file mode 100644 index 000000000..dcbb51ba1 --- /dev/null +++ b/docs/api/scorer.rst @@ -0,0 +1,17 @@ +Scorer +====== + +The ``Scorer`` class defines custom scoring logic for evaluating scenario outputs. +Scorers produce a score in the range [0.0, 1.0] for scenario runs. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_scorer + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.scorer + :members: diff --git a/docs/api/secret.rst b/docs/api/secret.rst new file mode 100644 index 000000000..641e0b9ed --- /dev/null +++ b/docs/api/secret.rst @@ -0,0 +1,17 @@ +Secret +====== + +The ``Secret`` class manages encrypted key-value pairs that can be injected +into devbox environments as environment variables. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_secret + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.secret + :members: diff --git a/docs/api/snapshot.rst b/docs/api/snapshot.rst new file mode 100644 index 000000000..1226dc250 --- /dev/null +++ b/docs/api/snapshot.rst @@ -0,0 +1,17 @@ +Snapshot +======== + +The ``Snapshot`` class represents a point-in-time disk snapshot of a devbox. +Use snapshots to save and restore devbox state. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_snapshot + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.snapshot + :members: diff --git a/docs/api/storage_object.rst b/docs/api/storage_object.rst new file mode 100644 index 000000000..fd86df3f3 --- /dev/null +++ b/docs/api/storage_object.rst @@ -0,0 +1,17 @@ +Storage Object +============== + +The ``StorageObject`` class manages file storage objects that can be uploaded, downloaded, +and mounted into devboxes. + +Asynchronous API +---------------- + +.. automodule:: runloop_api_client.sdk.async_storage_object + :members: + +Synchronous API +--------------- + +.. automodule:: runloop_api_client.sdk.storage_object + :members: diff --git a/docs/sdk/types.rst b/docs/api/types.rst similarity index 53% rename from docs/sdk/types.rst rename to docs/api/types.rst index ab6abafee..e436002ca 100644 --- a/docs/sdk/types.rst +++ b/docs/api/types.rst @@ -50,7 +50,7 @@ File Operation Parameters Network Tunnel Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxCreateTunnelParams +.. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxEnableTunnelParams .. autotypeddict:: runloop_api_client.sdk._types.SDKDevboxRemoveTunnelParams @@ -78,6 +78,15 @@ These TypeDicts define parameters for storage object creation, listing, and down .. autotypeddict:: runloop_api_client.sdk._types.SDKObjectDownloadParams +Agent Parameters +---------------- + +These TypeDicts define parameters for agent creation and listing. + +.. autotypeddict:: runloop_api_client.sdk._types.SDKAgentCreateParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKAgentListParams + Scorer Parameters ----------------- @@ -89,6 +98,84 @@ These TypeDicts define parameters for scorer creation, listing, and updating. .. autotypeddict:: runloop_api_client.sdk._types.SDKScorerUpdateParams +Axon Parameters +--------------- + +These TypeDicts define parameters for axon creation, listing, publishing, and SQL operations. + +.. autotypeddict:: runloop_api_client.sdk._types.SDKAxonCreateParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKAxonListParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKAxonPublishParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKAxonSqlQueryParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKAxonSqlBatchParams + +Scenario Parameters +------------------- + +These TypeDicts define parameters for scenario listing, updating, and running. + +.. autotypeddict:: runloop_api_client.sdk._types.SDKScenarioListParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKScenarioUpdateParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKScenarioRunParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKScenarioRunAsyncParams + +Benchmark Parameters +-------------------- + +These TypeDicts define parameters for benchmark creation, listing, updating, and running. + +.. autotypeddict:: runloop_api_client.sdk._types.SDKBenchmarkCreateParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKBenchmarkListParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKBenchmarkUpdateParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKBenchmarkStartRunParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKBenchmarkListRunsParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKBenchmarkRunListScenarioRunsParams + +Network Policy Parameters +------------------------- + +These TypeDicts define parameters for network policy creation, listing, and updating. + +.. autotypeddict:: runloop_api_client.sdk._types.SDKNetworkPolicyCreateParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKNetworkPolicyListParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKNetworkPolicyUpdateParams + +MCP Config Parameters +--------------------- + +These TypeDicts define parameters for MCP (Model Context Protocol) configuration creation, listing, and updating. + +.. autotypeddict:: runloop_api_client.sdk._types.SDKMcpConfigCreateParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKMcpConfigListParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKMcpConfigUpdateParams + +Gateway Config Parameters +------------------------- + +These TypeDicts define parameters for gateway configuration creation, listing, and updating. + +.. autotypeddict:: runloop_api_client.sdk._types.SDKGatewayConfigCreateParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKGatewayConfigListParams + +.. autotypeddict:: runloop_api_client.sdk._types.SDKGatewayConfigUpdateParams + Core Request Options -------------------- @@ -109,14 +196,4 @@ These TypeDicts define options for timeouts, idempotency, polling, and other low Base API Type Reference ----------------------- -.. automodule:: runloop_api_client.types.shared_params - :members: - :undoc-members: - :imported-members: - :member-order: groupwise - -.. automodule:: runloop_api_client.types - :members: - :undoc-members: - :imported-members: - :member-order: groupwise \ No newline at end of file +.. auto-all-types:: diff --git a/docs/conf.py b/docs/conf.py index 3bdd4d06a..d5a897e66 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,8 +3,11 @@ # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +from __future__ import annotations + import os import sys +from typing import Any # Add the src directory to the path so we can import the package sys.path.insert(0, os.path.abspath("../src")) @@ -54,6 +57,37 @@ autodoc_typehints = "description" autodoc_typehints_description_target = "documented" + +def _inject_type_submodules(_app: Any, docname: str, source: list[str]) -> None: + """Auto-generate automodule directives for all type submodules. + + Replaces the ``.. auto-all-types::`` placeholder in types.rst with + automodule directives for every submodule in runloop_api_client.types. + This ensures all types (including file-local helper types like Lifecycle + and BuildContext) get documented at their actual module path, making + cross-references resolve without any path rewriting. + """ + if docname != "api/types": + return + import pkgutil + + import runloop_api_client.types as types_pkg + + directives: list[str] = [] + for _, modname, ispkg in sorted( + pkgutil.walk_packages(types_pkg.__path__, types_pkg.__name__ + "."), + key=lambda x: x[1], + ): + if ispkg: + continue + directives.append(f".. automodule:: {modname}\n :members:\n :undoc-members:\n") + source[0] = source[0].replace(".. auto-all-types::", "\n".join(directives)) + + +def setup(app: Any) -> None: + app.connect("source-read", _inject_type_submodules) + + # Intersphinx mapping intersphinx_mapping = { "python": ("https://docs.python.org/3", None), diff --git a/docs/index.rst b/docs/index.rst index 99e32b84e..bae150e1f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,16 +2,8 @@ Runloop Python SDK Documentation ================================== The Runloop Python SDK provides a Pythonic, object-oriented interface for managing -devboxes, blueprints, snapshots, and storage objects. The SDK offers both synchronous -and asynchronous variants to match your runtime requirements. - -.. toctree:: - :maxdepth: 1 - :caption: Contents: - - sdk/async/index - sdk/sync/index - sdk/types +devboxes, blueprints, snapshots, storage objects, scenarios, benchmarks, and more. +The SDK offers both asynchronous and synchronous variants with identical interfaces. Installation ------------ @@ -25,23 +17,6 @@ Install the SDK using pip: Quick Start ----------- -Synchronous Example -~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - from runloop_api_client import RunloopSDK - - runloop = RunloopSDK() - - # Create a ready-to-use devbox - with runloop.devbox.create(name="my-devbox") as devbox: - result = devbox.cmd.exec("echo 'Hello from Runloop!'") - print(result.stdout()) - -Asynchronous Example -~~~~~~~~~~~~~~~~~~~~ - .. code-block:: python import asyncio @@ -49,17 +24,34 @@ Asynchronous Example async def main(): runloop = AsyncRunloopSDK() - + async with await runloop.devbox.create(name="my-devbox") as devbox: result = await devbox.cmd.exec("echo 'Hello from Runloop!'") print(await result.stdout()) asyncio.run(main()) +A synchronous variant is also available: + +.. code-block:: python + + from runloop_api_client import RunloopSDK + + runloop = RunloopSDK() + + with runloop.devbox.create(name="my-devbox") as devbox: + result = devbox.cmd.exec("echo 'Hello from Runloop!'") + print(result.stdout()) + +.. toctree:: + :maxdepth: 2 + :caption: API Reference + + api/index + Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/docs/sdk/async/agent.rst b/docs/sdk/async/agent.rst deleted file mode 100644 index 724b23bd5..000000000 --- a/docs/sdk/async/agent.rst +++ /dev/null @@ -1,7 +0,0 @@ -Agent -====== - -The ``AsyncAgent`` class provides asynchronous methods for managing and interacting with stored Agents. - -.. automodule:: runloop_api_client.sdk.async_agent - :members: diff --git a/docs/sdk/async/blueprint.rst b/docs/sdk/async/blueprint.rst deleted file mode 100644 index c28afd382..000000000 --- a/docs/sdk/async/blueprint.rst +++ /dev/null @@ -1,8 +0,0 @@ -Blueprint -========= - -The ``AsyncBlueprint`` class provides asynchronous methods for managing devbox blueprints. - -.. automodule:: runloop_api_client.sdk.async_blueprint - :members: - diff --git a/docs/sdk/async/core.rst b/docs/sdk/async/core.rst deleted file mode 100644 index 96fc11a80..000000000 --- a/docs/sdk/async/core.rst +++ /dev/null @@ -1,8 +0,0 @@ -Core Module -=========== - -The core asynchronous SDK module provides the main entry point and async operation classes. - -.. autoclass:: runloop_api_client.sdk.async_.AsyncRunloopSDK - -.. automodule:: runloop_api_client.sdk.async_ \ No newline at end of file diff --git a/docs/sdk/async/devbox.rst b/docs/sdk/async/devbox.rst deleted file mode 100644 index 3698daa17..000000000 --- a/docs/sdk/async/devbox.rst +++ /dev/null @@ -1,7 +0,0 @@ -Devbox -====== - -The ``AsyncDevbox`` class provides asynchronous methods for managing and interacting with a devbox instance. - -.. automodule:: runloop_api_client.sdk.async_devbox - :members: \ No newline at end of file diff --git a/docs/sdk/async/execution.rst b/docs/sdk/async/execution.rst deleted file mode 100644 index 988688094..000000000 --- a/docs/sdk/async/execution.rst +++ /dev/null @@ -1,8 +0,0 @@ -Execution -========= - -The ``AsyncExecution`` class represents an asynchronous command execution in progress. - -.. automodule:: runloop_api_client.sdk.async_execution - :members: - diff --git a/docs/sdk/async/execution_result.rst b/docs/sdk/async/execution_result.rst deleted file mode 100644 index e2f6f3ad1..000000000 --- a/docs/sdk/async/execution_result.rst +++ /dev/null @@ -1,8 +0,0 @@ -Execution Result -================ - -The ``AsyncExecutionResult`` class represents the result of a completed command execution. - -.. automodule:: runloop_api_client.sdk.async_execution_result - :members: - diff --git a/docs/sdk/async/index.rst b/docs/sdk/async/index.rst deleted file mode 100644 index df9ad2585..000000000 --- a/docs/sdk/async/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -Asynchronous SDK -================ - -The asynchronous SDK provides a non-blocking interface for managing devboxes, blueprints, snapshots, and storage objects. Use this variant when working with async/await Python code. - -.. toctree:: - :maxdepth: 2 - - core - devbox - execution - execution_result - blueprint - snapshot - storage_object - scorer - agent diff --git a/docs/sdk/async/scorer.rst b/docs/sdk/async/scorer.rst deleted file mode 100644 index 7564092d8..000000000 --- a/docs/sdk/async/scorer.rst +++ /dev/null @@ -1,9 +0,0 @@ -Scorer -====== - -The ``AsyncScorer`` class provides asynchronous methods for managing custom scenario scorers. - -.. automodule:: runloop_api_client.sdk.async_scorer - :members: - - diff --git a/docs/sdk/async/snapshot.rst b/docs/sdk/async/snapshot.rst deleted file mode 100644 index 75826695a..000000000 --- a/docs/sdk/async/snapshot.rst +++ /dev/null @@ -1,8 +0,0 @@ -Snapshot -======== - -The ``AsyncSnapshot`` class provides asynchronous methods for managing devbox snapshots. - -.. automodule:: runloop_api_client.sdk.async_snapshot - :members: - diff --git a/docs/sdk/async/storage_object.rst b/docs/sdk/async/storage_object.rst deleted file mode 100644 index bc7f79b35..000000000 --- a/docs/sdk/async/storage_object.rst +++ /dev/null @@ -1,8 +0,0 @@ -Storage Object -============== - -The ``AsyncStorageObject`` class provides asynchronous methods for managing storage objects. - -.. automodule:: runloop_api_client.sdk.async_storage_object - :members: - diff --git a/docs/sdk/sync/agent.rst b/docs/sdk/sync/agent.rst deleted file mode 100644 index 207c4b611..000000000 --- a/docs/sdk/sync/agent.rst +++ /dev/null @@ -1,7 +0,0 @@ -Agent -====== - -The ``Agent`` class provides synchronous methods for managing and interacting with stored Agents. - -.. automodule:: runloop_api_client.sdk.agent - :members: diff --git a/docs/sdk/sync/blueprint.rst b/docs/sdk/sync/blueprint.rst deleted file mode 100644 index c7e250285..000000000 --- a/docs/sdk/sync/blueprint.rst +++ /dev/null @@ -1,8 +0,0 @@ -Blueprint -========= - -The ``Blueprint`` class provides synchronous methods for managing devbox blueprints. - -.. automodule:: runloop_api_client.sdk.blueprint - :members: - diff --git a/docs/sdk/sync/core.rst b/docs/sdk/sync/core.rst deleted file mode 100644 index 66af97ba2..000000000 --- a/docs/sdk/sync/core.rst +++ /dev/null @@ -1,8 +0,0 @@ -Core Module -=========== - -The core synchronous SDK module provides the main entry point and operation classes. - -.. autoclass:: runloop_api_client.sdk.sync.RunloopSDK - -.. automodule:: runloop_api_client.sdk.sync \ No newline at end of file diff --git a/docs/sdk/sync/devbox.rst b/docs/sdk/sync/devbox.rst deleted file mode 100644 index 19875fc8c..000000000 --- a/docs/sdk/sync/devbox.rst +++ /dev/null @@ -1,7 +0,0 @@ -Devbox -====== - -The ``Devbox`` class provides synchronous methods for managing and interacting with a devbox instance. - -.. automodule:: runloop_api_client.sdk.devbox - :members: \ No newline at end of file diff --git a/docs/sdk/sync/execution.rst b/docs/sdk/sync/execution.rst deleted file mode 100644 index 8159eae1e..000000000 --- a/docs/sdk/sync/execution.rst +++ /dev/null @@ -1,8 +0,0 @@ -Execution -========= - -The ``Execution`` class represents an asynchronous command execution in progress. - -.. automodule:: runloop_api_client.sdk.execution - :members: - diff --git a/docs/sdk/sync/execution_result.rst b/docs/sdk/sync/execution_result.rst deleted file mode 100644 index 92496683a..000000000 --- a/docs/sdk/sync/execution_result.rst +++ /dev/null @@ -1,8 +0,0 @@ -Execution Result -================ - -The ``ExecutionResult`` class represents the result of a completed command execution. - -.. automodule:: runloop_api_client.sdk.execution_result - :members: - diff --git a/docs/sdk/sync/index.rst b/docs/sdk/sync/index.rst deleted file mode 100644 index 6e77b9d7d..000000000 --- a/docs/sdk/sync/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -Synchronous SDK -=============== - -The synchronous SDK provides a blocking interface for managing devboxes, blueprints, snapshots, and storage objects. Use this variant when working in synchronous Python code. - -.. toctree:: - :maxdepth: 2 - - core - devbox - execution - execution_result - blueprint - snapshot - storage_object - scorer - agent - diff --git a/docs/sdk/sync/scorer.rst b/docs/sdk/sync/scorer.rst deleted file mode 100644 index 09b98dfb2..000000000 --- a/docs/sdk/sync/scorer.rst +++ /dev/null @@ -1,9 +0,0 @@ -Scorer -====== - -The ``Scorer`` class provides synchronous methods for managing custom scenario scorers. - -.. automodule:: runloop_api_client.sdk.scorer - :members: - - diff --git a/docs/sdk/sync/snapshot.rst b/docs/sdk/sync/snapshot.rst deleted file mode 100644 index 6b0bb358d..000000000 --- a/docs/sdk/sync/snapshot.rst +++ /dev/null @@ -1,8 +0,0 @@ -Snapshot -======== - -The ``Snapshot`` class provides synchronous methods for managing devbox snapshots. - -.. automodule:: runloop_api_client.sdk.snapshot - :members: - diff --git a/docs/sdk/sync/storage_object.rst b/docs/sdk/sync/storage_object.rst deleted file mode 100644 index 97b4bb77d..000000000 --- a/docs/sdk/sync/storage_object.rst +++ /dev/null @@ -1,8 +0,0 @@ -Storage Object -============== - -The ``StorageObject`` class provides synchronous methods for managing storage objects. - -.. automodule:: runloop_api_client.sdk.storage_object - :members: - diff --git a/uv.lock b/uv.lock index e2e199a71..15f6eb6a7 100644 --- a/uv.lock +++ b/uv.lock @@ -2386,7 +2386,7 @@ wheels = [ [[package]] name = "runloop-api-client" -version = "1.14.0" +version = "1.18.1" source = { editable = "." } dependencies = [ { name = "anyio" },