added install-hooks to make it easier to lint and regen examples becuase i keep forgetting this!

Author: james-rl

EXAMPLES.md

@@ -44,15 +44,17 @@ uv run pytest -m smoketest tests/smoketests/examples/
 <a id="devbox-from-blueprint-lifecycle"></a>
 ## Devbox From Blueprint (Run Command, Shutdown)
 
-**Use case:** Create a devbox from a blueprint, run a command, validate output, and cleanly tear everything down.
+**Use case:** Create a devbox from a blueprint, run a command, fetch logs, validate output, and cleanly tear everything down.
 
-**Tags:** `devbox`, `blueprint`, `commands`, `cleanup`
+**Tags:** `devbox`, `blueprint`, `commands`, `logs`, `cleanup`
 
 ### Workflow
 - Create a blueprint
+- Fetch blueprint build logs
 - Create a devbox from the blueprint
 - Execute a command in the devbox
-- Validate exit code and stdout
+- Fetch devbox logs
+- Validate exit code, stdout, and logs
 - Shutdown devbox and delete blueprint
 
 ### Prerequisites

README.md

@@ -497,6 +497,17 @@ print(runloop_api_client.__version__)
 
 Python 3.9 or higher.
 
+## Development
+
+After cloning the repository, run the bootstrap script and install git hooks:
+
+```sh
+./scripts/bootstrap
+./scripts/install-hooks
+```
+
+This installs pre-push hooks that run linting and verify generated files are up to date.
+
 ## Contributing
 
 See [the contributing documentation](./CONTRIBUTING.md).

examples/devbox_from_blueprint_lifecycle.py

@@ -82,12 +82,12 @@ def recipe(ctx: RecipeContext) -> RecipeOutput:
             ),
             ExampleCheck(
                 name="blueprint build logs are retrievable",
-                passed=blueprint_logs is not None and hasattr(blueprint_logs, "logs"),
+                passed=hasattr(blueprint_logs, "logs"),
                 details=f"blueprint_log_count={len(blueprint_logs.logs)}",
             ),
             ExampleCheck(
                 name="devbox logs are retrievable",
-                passed=devbox_logs is not None and hasattr(devbox_logs, "logs"),
+                passed=hasattr(devbox_logs, "logs"),
                 details=f"devbox_log_count={len(devbox_logs.logs)}",
             ),
         ],

scripts/install-hooks

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+echo "==> Installing git hooks..."
+
+mkdir -p .git/hooks
+
+cat > .git/hooks/pre-push << 'EOF'
+#!/usr/bin/env bash
+set -e
+cd "$(git rev-parse --show-toplevel)"
+
+echo "==> Running lint checks..."
+./scripts/lint
+
+echo "==> Checking EXAMPLES.md is up to date..."
+uv run python scripts/generate_examples_md.py --check
+
+echo "==> All checks passed!"
+EOF
+
+chmod +x .git/hooks/pre-push
+
+echo "==> Git hooks installed successfully!"

src/runloop_api_client/sdk/async_devbox.py

@@ -15,7 +15,6 @@
     DevboxExecutionDetailView,
     DevboxCreateSSHKeyResponse,
 )
-from ..types.devboxes.devbox_logs_list_view import DevboxLogsListView
 from ._types import (
     LogCallback,
     BaseRequestOptions,
@@ -34,6 +33,7 @@
     SDKDevboxSnapshotDiskAsyncParams,
     SDKDevboxWriteFileContentsParams,
 )
+from .._types import omit
 from .._client import AsyncRunloop
 from ._helpers import filter_params
 from .._streaming import AsyncStream
@@ -42,6 +42,7 @@
 from .async_execution import AsyncExecution, _AsyncStreamingGroup
 from .async_execution_result import AsyncExecutionResult
 from ..types.devbox_execute_async_params import DevboxNiceExecuteAsyncParams
+from ..types.devboxes.devbox_logs_list_view import DevboxLogsListView
 from ..types.devbox_async_execution_detail_view import DevboxAsyncExecutionDetailView
 
 StreamFactory = Callable[[], Awaitable[AsyncStream[ExecutionUpdateChunk]]]
@@ -191,8 +192,8 @@ async def logs(
         """
         return await self._client.devboxes.logs.list(
             self._id,
-            execution_id=execution_id,
-            shell_name=shell_name,
+            execution_id=execution_id if execution_id is not None else omit,
+            shell_name=shell_name if shell_name is not None else omit,
             **options,
         )
 

src/runloop_api_client/sdk/devbox.py

@@ -15,7 +15,6 @@
     DevboxExecutionDetailView,
     DevboxCreateSSHKeyResponse,
 )
-from ..types.devboxes.devbox_logs_list_view import DevboxLogsListView
 from ._types import (
     LogCallback,
     BaseRequestOptions,
@@ -35,6 +34,7 @@
     SDKDevboxSnapshotDiskAsyncParams,
     SDKDevboxWriteFileContentsParams,
 )
+from .._types import omit
 from .._client import Runloop
 from ._helpers import filter_params
 from .execution import Execution, _StreamingGroup
@@ -43,6 +43,7 @@
 from ..types.devboxes import ExecutionUpdateChunk
 from .execution_result import ExecutionResult
 from ..types.devbox_execute_async_params import DevboxNiceExecuteAsyncParams
+from ..types.devboxes.devbox_logs_list_view import DevboxLogsListView
 from ..types.devbox_async_execution_detail_view import DevboxAsyncExecutionDetailView
 
 if TYPE_CHECKING:
@@ -190,8 +191,8 @@ def logs(
         """
         return self._client.devboxes.logs.list(
             self._id,
-            execution_id=execution_id,
-            shell_name=shell_name,
+            execution_id=execution_id if execution_id is not None else omit,
+            shell_name=shell_name if shell_name is not None else omit,
             **options,
         )