update builder docstrings to use fluent pattern, replaced all references to RunloopSDK() to 'runloop' instead of 'sdk' or 'client'

Author: sid-rl

README.md

@@ -33,10 +33,10 @@ For a higher-level, Pythonic interface, check out the new [`RunloopSDK`](README-
 ```python
 from runloop_api_client import RunloopSDK
 
-sdk = RunloopSDK()  # Uses RUNLOOP_API_KEY environment variable by default
+runloop = RunloopSDK()  # Uses RUNLOOP_API_KEY environment variable by default
 
 # Create a devbox and execute commands with a clean, object-oriented interface
-with sdk.devbox.create(name="my-devbox") as devbox:
+with runloop.devbox.create(name="my-devbox") as devbox:
     result = devbox.cmd.exec("echo 'Hello from Runloop!'")
     print(result.stdout())
 ```

src/runloop_api_client/sdk/async_.py

@@ -776,10 +776,12 @@ class AsyncScenarioOps:
         >>> scenarios = await runloop.scenario.list()
 
     Example using builder:
-        >>> builder = runloop.scenario.builder("my-scenario")
-        >>> builder.from_blueprint_id("bp-xxx")
-        >>> builder.with_problem_statement("Fix the bug")
-        >>> builder.add_test_scorer("tests", test_command="pytest")
+        >>> builder = (
+        ...     runloop.scenario.builder("my-scenario")
+        ...     .from_blueprint(blueprint)
+        ...     .with_problem_statement("Fix the bug")
+        ...     .add_test_scorer("tests", test_command="pytest")
+        ... )
         >>> scenario = await builder.push()
     """
 

src/runloop_api_client/sdk/async_scenario_builder.py

@@ -31,11 +31,13 @@ class AsyncScenarioBuilder:
     before pushing it to the platform.
 
     Example:
-        >>> builder = sdk.scenario.builder("my-scenario")
-        >>> builder.from_blueprint(blueprint)
-        >>> builder.with_working_directory("/app")
-        >>> builder.with_problem_statement("Fix the bug in main.py")
-        >>> builder.add_test_scorer("tests", test_command="pytest")
+        >>> builder = (
+        ...     runloop.scenario.builder("my-scenario")
+        ...     .from_blueprint(blueprint)
+        ...     .with_working_directory("/app")
+        ...     .with_problem_statement("Fix the bug in main.py")
+        ...     .add_test_scorer("tests", test_command="pytest")
+        ... )
         >>> scenario = await builder.push()
     """
 

src/runloop_api_client/sdk/scenario_builder.py

@@ -31,11 +31,13 @@ class ScenarioBuilder:
     before pushing it to the platform.
 
     Example:
-        >>> builder = sdk.scenario.builder("my-scenario")
-        >>> builder.from_blueprint(blueprint)
-        >>> builder.with_working_directory("/app")
-        >>> builder.with_problem_statement("Fix the bug in main.py")
-        >>> builder.add_test_scorer("tests", test_command="pytest")
+        >>> builder = (
+        ...     runloop.scenario.builder("my-scenario")
+        ...     .from_blueprint(blueprint)
+        ...     .with_working_directory("/app")
+        ...     .with_problem_statement("Fix the bug in main.py")
+        ...     .add_test_scorer("tests", test_command="pytest")
+        ... )
         >>> scenario = builder.push()
     """
 

src/runloop_api_client/sdk/sync.py

@@ -797,10 +797,12 @@ class ScenarioOps:
         >>> scenarios = runloop.scenario.list()
 
     Example using builder:
-        >>> builder = runloop.scenario.builder("my-scenario")
-        >>> builder.from_blueprint_id("bp-xxx")
-        >>> builder.with_problem_statement("Fix the bug")
-        >>> builder.add_test_scorer("tests", test_command="pytest")
+        >>> builder = (
+        ...     runloop.scenario.builder("my-scenario")
+        ...     .from_blueprint(blueprint)
+        ...     .with_problem_statement("Fix the bug")
+        ...     .add_test_scorer("tests", test_command="pytest")
+        ... )
         >>> scenario = builder.push()
     """
 

tests/sdk/test_async_ops.py

@@ -1193,33 +1193,33 @@ class TestAsyncRunloopSDK:
 
     def test_init(self) -> None:
         """Test AsyncRunloopSDK initialization."""
-        sdk = AsyncRunloopSDK(bearer_token="test-token")
-        assert sdk.api is not None
-        assert isinstance(sdk.agent, AsyncAgentOps)
-        assert isinstance(sdk.devbox, AsyncDevboxOps)
-        assert isinstance(sdk.scorer, AsyncScorerOps)
-        assert isinstance(sdk.snapshot, AsyncSnapshotOps)
-        assert isinstance(sdk.blueprint, AsyncBlueprintOps)
-        assert isinstance(sdk.storage_object, AsyncStorageObjectOps)
+        runloop = AsyncRunloopSDK(bearer_token="test-token")
+        assert runloop.api is not None
+        assert isinstance(runloop.agent, AsyncAgentOps)
+        assert isinstance(runloop.devbox, AsyncDevboxOps)
+        assert isinstance(runloop.scorer, AsyncScorerOps)
+        assert isinstance(runloop.snapshot, AsyncSnapshotOps)
+        assert isinstance(runloop.blueprint, AsyncBlueprintOps)
+        assert isinstance(runloop.storage_object, AsyncStorageObjectOps)
 
     @pytest.mark.asyncio
     async def test_aclose(self) -> None:
         """Test aclose method."""
-        sdk = AsyncRunloopSDK(bearer_token="test-token")
+        runloop = AsyncRunloopSDK(bearer_token="test-token")
         # Verify aclose doesn't raise
-        await sdk.aclose()
+        await runloop.aclose()
 
     @pytest.mark.asyncio
     async def test_context_manager(self) -> None:
         """Test context manager behavior."""
-        async with AsyncRunloopSDK(bearer_token="test-token") as sdk:
-            assert sdk.api is not None
+        async with AsyncRunloopSDK(bearer_token="test-token") as runloop:
+            assert runloop.api is not None
         # Verify context manager properly closes (implementation detail of context manager protocol)
 
     def test_api_property(self) -> None:
         """Test api property access."""
-        sdk = AsyncRunloopSDK(bearer_token="test-token")
-        assert sdk.api is not None
-        assert hasattr(sdk.api, "devboxes")
-        assert hasattr(sdk.api, "blueprints")
-        assert hasattr(sdk.api, "objects")
+        runloop = AsyncRunloopSDK(bearer_token="test-token")
+        assert runloop.api is not None
+        assert hasattr(runloop.api, "devboxes")
+        assert hasattr(runloop.api, "blueprints")
+        assert hasattr(runloop.api, "objects")

tests/sdk/test_ops.py

@@ -1070,36 +1070,36 @@ class TestRunloopSDK:
 
     def test_init(self) -> None:
         """Test RunloopSDK initialization."""
-        sdk = RunloopSDK(bearer_token="test-token")
-        assert sdk.api is not None
-        assert isinstance(sdk.agent, AgentOps)
-        assert isinstance(sdk.devbox, DevboxOps)
-        assert isinstance(sdk.scorer, ScorerOps)
-        assert isinstance(sdk.snapshot, SnapshotOps)
-        assert isinstance(sdk.blueprint, BlueprintOps)
-        assert isinstance(sdk.storage_object, StorageObjectOps)
+        runloop = RunloopSDK(bearer_token="test-token")
+        assert runloop.api is not None
+        assert isinstance(runloop.agent, AgentOps)
+        assert isinstance(runloop.devbox, DevboxOps)
+        assert isinstance(runloop.scorer, ScorerOps)
+        assert isinstance(runloop.snapshot, SnapshotOps)
+        assert isinstance(runloop.blueprint, BlueprintOps)
+        assert isinstance(runloop.storage_object, StorageObjectOps)
 
     def test_init_with_max_retries(self) -> None:
         """Test RunloopSDK initialization with max_retries."""
-        sdk = RunloopSDK(bearer_token="test-token", max_retries=3)
-        assert sdk.api is not None
+        runloop = RunloopSDK(bearer_token="test-token", max_retries=3)
+        assert runloop.api is not None
 
     def test_close(self) -> None:
         """Test close method."""
-        sdk = RunloopSDK(bearer_token="test-token")
+        runloop = RunloopSDK(bearer_token="test-token")
         # Verify close doesn't raise
-        sdk.close()
+        runloop.close()
 
     def test_context_manager(self) -> None:
         """Test context manager behavior."""
-        with RunloopSDK(bearer_token="test-token") as sdk:
-            assert sdk.api is not None
+        with RunloopSDK(bearer_token="test-token") as runloop:
+            assert runloop.api is not None
         # Verify context manager properly closes (implementation detail of context manager protocol)
 
     def test_api_property(self) -> None:
         """Test api property access."""
-        sdk = RunloopSDK(bearer_token="test-token")
-        assert sdk.api is not None
-        assert hasattr(sdk.api, "devboxes")
-        assert hasattr(sdk.api, "blueprints")
-        assert hasattr(sdk.api, "objects")
+        runloop = RunloopSDK(bearer_token="test-token")
+        assert runloop.api is not None
+        assert hasattr(runloop.api, "devboxes")
+        assert hasattr(runloop.api, "blueprints")
+        assert hasattr(runloop.api, "objects")

tests/smoketests/sdk/conftest.py

@@ -24,16 +24,16 @@ def sdk_client() -> Iterator[RunloopSDK]:
     if not bearer_token:
         pytest.skip("RUNLOOP_API_KEY environment variable not set")
 
-    client = RunloopSDK(
+    runloop = RunloopSDK(
         bearer_token=bearer_token,
         base_url=base_url,
     )
 
     try:
-        yield client
+        yield runloop
     finally:
         try:
-            client.close()
+            runloop.close()
         except Exception:
             pass
 
@@ -52,17 +52,17 @@ async def async_sdk_client() -> AsyncIterator[AsyncRunloopSDK]:
     if not bearer_token:
         pytest.skip("RUNLOOP_API_KEY environment variable not set")
 
-    client = AsyncRunloopSDK(
+    runloop = AsyncRunloopSDK(
         bearer_token=bearer_token,
         base_url=base_url,
     )
 
     try:
-        async with client:
-            yield client
+        async with runloop:
+            yield runloop
     except Exception:
         # If context manager fails, try manual cleanup
         try:
-            await client.aclose()
+            await runloop.aclose()
         except Exception:
             pass