Merge branch 'main' of github.com:runloopai/api-client-python

Author: james-rl

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.69.0"
+  ".": "1.0.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 97
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-0dd27c6877ed117c50fe0af95cee4d54c646d2484368e131b8e3315eba3fffcc.yml
-openapi_spec_hash: 68f663172747aef8e66f2b23289efc7b
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-cb2d725f71e87810cd872eacd70e867ca10f94980fdf9c78bb2844c02ee47bf3.yml
+openapi_spec_hash: 16ce3e9184fc2afdee66db18a83a96e8
 config_hash: 2363f563f42501d2b1587a4f64bdccaf

CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## 1.0.0 (2025-12-02)
+
+Full Changelog: [v0.69.0...v1.0.0](https://github.com/runloopai/api-client-python/compare/v0.69.0...v1.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* **devbox:** made command positional arg in exec and exec_async ([#695](https://github.com/runloopai/api-client-python/issues/695))
+
+### Features
+
+* **blueprints:** Add build context to the OpenAPI spec ([#6494](https://github.com/runloopai/api-client-python/issues/6494)) ([d202b94](https://github.com/runloopai/api-client-python/commit/d202b942c07614ca954a8bbe3a9a6302e9a04216))
+* **devbox:** added devbox.shell(shellName) command and stateful shell class to SDK ([#696](https://github.com/runloopai/api-client-python/issues/696)) ([c1e8f09](https://github.com/runloopai/api-client-python/commit/c1e8f0965a419ff53d830ba3c43a1c9a29dae5c7))
+* **devbox:** made command positional arg in exec and exec_async ([#695](https://github.com/runloopai/api-client-python/issues/695)) ([6cc8c2f](https://github.com/runloopai/api-client-python/commit/6cc8c2fd4f904e8cc4386d81558157ca6fb69bfa))
+* **sdk:** added scorer classes to sdk ([#698](https://github.com/runloopai/api-client-python/issues/698)) ([85f798f](https://github.com/runloopai/api-client-python/commit/85f798f2d8a7727b783e01a260ff0a52bdf01d78))
+
+
+### Bug Fixes
+
+* **api:** don't ignore devbox keep_alive, suspend and resume in api ([fe3589f](https://github.com/runloopai/api-client-python/commit/fe3589f5fbb36a5b79f1d4a25e86f88676556fdb))
+* **devbox:** launch parameter typo ([1c9c346](https://github.com/runloopai/api-client-python/commit/1c9c346e475b64fc389928fee0f7140e532c4f9c))
+* **scenarios:** update parameters for manually maintained start_run_and_await_env_ready methods ([#692](https://github.com/runloopai/api-client-python/issues/692)) ([8000495](https://github.com/runloopai/api-client-python/commit/8000495f70b2e6f4f12742fb8a6d641dbbc088ca))
+* **scorer:** fixed RL_TEST_CONTEXT to RL_SCORER_CONTEXT ([df43a42](https://github.com/runloopai/api-client-python/commit/df43a42a45b9ce67aba27835a41c9a0ebfc6a407))
+
+
+### Chores
+
+* **blueprints:** Add build context examples ([#694](https://github.com/runloopai/api-client-python/issues/694)) ([6e63928](https://github.com/runloopai/api-client-python/commit/6e6392864b3cde20dfea5d173fed9a156b960ccd))
+* hide build context APIs ([159a38f](https://github.com/runloopai/api-client-python/commit/159a38f0980c00430a1b949541076b0d63df2df2))
+* **mounts:** Update documentation for deprecated fields to direct the user to the replacement API ([4936844](https://github.com/runloopai/api-client-python/commit/4936844989ec7a0d37c835dd37b8007e8caba944))
+
 ## 0.69.0 (2025-11-21)
 
 Full Changelog: [v0.68.0...v0.69.0](https://github.com/runloopai/api-client-python/compare/v0.68.0...v0.69.0)

README-SDK.md

@@ -38,12 +38,12 @@ runloop = RunloopSDK()
 
 # Create a ready-to-use devbox
 with runloop.devbox.create(name="my-devbox") as devbox:
-    result = devbox.cmd.exec(command="echo 'Hello from Runloop!'")
+    result = devbox.cmd.exec("echo 'Hello from Runloop!'")
     print(result.stdout())
 
     # Stream stdout in real time
     devbox.cmd.exec(
-        command="ls -la",
+        "ls -la",
         stdout=lambda line: print("stdout:", line),
     )
 
@@ -68,13 +68,13 @@ from runloop_api_client import AsyncRunloopSDK
 async def main():
     runloop = AsyncRunloopSDK()
     async with await runloop.devbox.create(name="async-devbox") as devbox:
-        result = await devbox.cmd.exec(command="pwd")
+        result = await devbox.cmd.exec("pwd")
         print(await result.stdout())
 
         def capture(line: str) -> None:
             print(">>", line)
 
-        await devbox.cmd.exec(command="ls", stdout=capture)
+        await devbox.cmd.exec("ls", stdout=capture)
 
 asyncio.run(main())
 ```
@@ -147,13 +147,13 @@ Execute commands synchronously or asynchronously:
 
 ```python
 # Synchronous command execution (waits for completion)
-result = devbox.cmd.exec(command="ls -la")
+result = devbox.cmd.exec("ls -la")
 print("Output:", result.stdout())
 print("Exit code:", result.exit_code)
 print("Success:", result.success)
 
 # Asynchronous command execution (returns immediately)
-execution = devbox.cmd.exec_async(command="npm run dev")
+execution = devbox.cmd.exec_async("npm run dev")
 
 # Check execution status
 state = execution.get_state()
@@ -173,7 +173,7 @@ The `Execution` object provides fine-grained control over asynchronous command e
 
 ```python
 # Start a long-running process
-execution = devbox.cmd.exec_async(command="python train_model.py")
+execution = devbox.cmd.exec_async("python train_model.py")
 
 # Get the execution ID
 print("Execution ID:", execution.execution_id)
@@ -208,10 +208,10 @@ The `ExecutionResult` object contains the output and exit status of a completed
 
 ```python
 # From synchronous execution
-result = devbox.cmd.exec(command="ls -la /tmp")
+result = devbox.cmd.exec("ls -la /tmp")
 
 # Or from asynchronous execution
-execution = devbox.cmd.exec_async(command="echo 'test'")
+execution = devbox.cmd.exec_async("echo 'test'")
 result = execution.result()
 
 # Access execution results
@@ -250,7 +250,7 @@ def handle_output(line: str) -> None:
     print("LOG:", line)
 
 result = devbox.cmd.exec(
-    command="python train.py",
+    "python train.py",
     stdout=handle_output,
     stderr=lambda line: print("ERR:", line),
     output=lambda line: print("ANY:", line),
@@ -267,7 +267,7 @@ def capture(line: str) -> None:
     log_queue.put_nowait(line)
 
 await devbox.cmd.exec(
-    command="tail -f /var/log/app.log",
+    "tail -f /var/log/app.log",
     stdout=capture,
 )
 ```
@@ -365,13 +365,13 @@ Devboxes support context managers for automatic cleanup:
 ```python
 # Synchronous
 with runloop.devbox.create(name="temp-devbox") as devbox:
-    result = devbox.cmd.exec(command="echo 'Hello'")
+    result = devbox.cmd.exec("echo 'Hello'")
     print(result.stdout())
 # devbox is automatically shutdown when exiting the context
 
 # Asynchronous
 async with await runloop.devbox.create(name="temp-devbox") as devbox:
-    result = await devbox.cmd.exec(command="echo 'Hello'")
+    result = await devbox.cmd.exec("echo 'Hello'")
     print(await result.stdout())
 # devbox is automatically shutdown when exiting the context
 ```
@@ -586,7 +586,7 @@ devbox = runloop.devbox.create(
 )
 
 # The storage object is now accessible at /home/user/data.txt in the devbox
-result = devbox.cmd.exec(command="cat /home/user/data.txt")
+result = devbox.cmd.exec("cat /home/user/data.txt")
 print(result.stdout())  # "Hello, World!"
 
 # Mount archived objects (tar, tgz, gzip) - they get extracted to a directory
@@ -607,7 +607,7 @@ devbox_with_archive = runloop.devbox.create(
 )
 
 # Access extracted archive contents
-result = devbox_with_archive.cmd.exec(command="ls -la /home/user/project/")
+result = devbox_with_archive.cmd.exec("ls -la /home/user/project/")
 print(result.stdout())
 ```
 
@@ -634,7 +634,7 @@ runloop = RunloopSDK()
 
 try:
     devbox = runloop.devbox.create(name="example-devbox")
-    result = devbox.cmd.exec(command="invalid-command")
+    result = devbox.cmd.exec("invalid-command")
 except runloop_api_client.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
@@ -694,14 +694,14 @@ async def main():
 
     # All the same operations, but with await
     async with await runloop.devbox.create(name="async-devbox") as devbox:
-        result = await devbox.cmd.exec(command="pwd")
+        result = await devbox.cmd.exec("pwd")
         print(await result.stdout())
 
         # Streaming (note: callbacks must be synchronous)
         def capture(line: str) -> None:
             print(">>", line)
 
-        await devbox.cmd.exec(command="ls", stdout=capture)
+        await devbox.cmd.exec("ls", stdout=capture)
 
         # Async file operations
         await devbox.file.write(path="/tmp/test.txt", contents="Hello")

docs/index.rst

@@ -34,7 +34,7 @@ Synchronous Example
 
    # Create a ready-to-use devbox
    with runloop.devbox.create(name="my-devbox") as devbox:
-       result = devbox.cmd.exec(command="echo 'Hello from Runloop!'")
+       result = devbox.cmd.exec("echo 'Hello from Runloop!'")
        print(result.stdout())
 
 Asynchronous Example
@@ -49,7 +49,7 @@ Asynchronous Example
        runloop = AsyncRunloopSDK()
        
        async with await runloop.devbox.create(name="my-devbox") as devbox:
-           result = await devbox.cmd.exec(command="echo 'Hello from Runloop!'")
+           result = await devbox.cmd.exec("echo 'Hello from Runloop!'")
            print(await result.stdout())
 
    asyncio.run(main())

docs/sdk/async/index.rst

@@ -26,4 +26,5 @@ Asynchronous resource classes for working with devboxes, blueprints, snapshots,
    blueprint
    snapshot
    storage_object
+   scorer
 

docs/sdk/async/scorer.rst

@@ -0,0 +1,9 @@
+Scorer
+======
+
+The ``AsyncScorer`` class provides asynchronous methods for managing custom scenario scorers.
+
+.. automodule:: runloop_api_client.sdk.async_scorer
+   :members:
+
+

docs/sdk/sync/index.rst

@@ -26,4 +26,5 @@ Synchronous resource classes for working with devboxes, blueprints, snapshots, a
    blueprint
    snapshot
    storage_object
+   scorer
 

docs/sdk/sync/scorer.rst

@@ -0,0 +1,9 @@
+Scorer
+======
+
+The ``Scorer`` class provides synchronous methods for managing custom scenario scorers.
+
+.. automodule:: runloop_api_client.sdk.scorer
+   :members:
+
+

docs/sdk/types.rst

@@ -78,6 +78,19 @@ These TypeDicts define parameters for storage object creation, listing, and down
 
 .. autotypeddict:: runloop_api_client.sdk._types.SDKObjectDownloadParams
 
+Scorer Parameters
+-----------------
+
+These TypeDicts define parameters for scorer creation, listing, updating, and validation.
+
+.. autotypeddict:: runloop_api_client.sdk._types.SDKScorerCreateParams
+
+.. autotypeddict:: runloop_api_client.sdk._types.SDKScorerListParams
+
+.. autotypeddict:: runloop_api_client.sdk._types.SDKScorerUpdateParams
+
+.. autotypeddict:: runloop_api_client.sdk._types.SDKScorerValidateParams
+
 Core Request Options
 --------------------