fixed name issue when running examples (thanks sid!)

Author: james-rl

EXAMPLES.md

@@ -29,7 +29,7 @@ Runnable examples live in [`examples/`](./examples).
 
 ### Run
 ```sh
-uv run examples/devbox_from_blueprint_lifecycle.py
+uv run python -m examples.devbox_from_blueprint_lifecycle
 ```
 
 ### Test
@@ -61,7 +61,7 @@ uv run pytest -m smoketest tests/smoketests/examples/
 
 ### Run
 ```sh
-GITHUB_TOKEN=ghp_xxx ANTHROPIC_API_KEY=sk-ant-xxx uv run examples/mcp_github_tools.py
+GITHUB_TOKEN=ghp_xxx ANTHROPIC_API_KEY=sk-ant-xxx uv run python -m examples.mcp_github_tools
 ```
 
 ### Test

examples/_harness.py

@@ -6,7 +6,7 @@
 from typing import Any, TypeVar, Callable, Awaitable
 from dataclasses import asdict
 
-from .types import (
+from .example_types import (
     ExampleCheck,
     RecipeOutput,
     ExampleResult,

examples/devbox_from_blueprint_lifecycle.py

@@ -17,7 +17,7 @@
   - cleanup
 prerequisites:
   - RUNLOOP_API_KEY
-run: uv run examples/devbox_from_blueprint_lifecycle.py
+run: uv run python -m examples.devbox_from_blueprint_lifecycle
 test: uv run pytest -m smoketest tests/smoketests/examples/
 ---
 """
@@ -29,7 +29,7 @@
 from runloop_api_client import RunloopSDK
 from runloop_api_client.lib.polling import PollingConfig
 
-from .types import ExampleCheck, RecipeOutput, RecipeContext
+from .example_types import ExampleCheck, RecipeOutput, RecipeContext
 from ._harness import run_as_cli, wrap_recipe
 
 

examples/types.py examples/example_types.pyexamples/types.py renamed to examples/example_types.py

@@ -21,7 +21,7 @@
   - RUNLOOP_API_KEY
   - GITHUB_TOKEN (GitHub PAT with repo scope)
   - ANTHROPIC_API_KEY
-run: GITHUB_TOKEN=ghp_xxx ANTHROPIC_API_KEY=sk-ant-xxx uv run examples/mcp_github_tools.py
+run: GITHUB_TOKEN=ghp_xxx ANTHROPIC_API_KEY=sk-ant-xxx uv run python -m examples.mcp_github_tools
 test: uv run pytest -m smoketest tests/smoketests/examples/
 ---
 """
@@ -34,7 +34,7 @@
 
 from runloop_api_client import RunloopSDK
 
-from .types import ExampleCheck, RecipeOutput, RecipeContext
+from .example_types import ExampleCheck, RecipeOutput, RecipeContext
 from ._harness import run_as_cli, wrap_recipe_with_options
 
 

examples/mcp_github_tools.py

@@ -7,7 +7,7 @@
 
 from typing import Any, Callable, cast
 
-from .types import ExampleResult
+from .example_types import ExampleResult
 from .mcp_github_tools import run_mcp_github_tools_example
 from .devbox_from_blueprint_lifecycle import run_devbox_from_blueprint_lifecycle_example
 

examples/registry.py

@@ -26,7 +26,7 @@
 - Execute commands with `await devbox.cmd.exec('command')`, not raw API calls
 - Always call `await devbox.shutdown()` to clean up resources (or use context manager)
 - Streaming callbacks (`stdout`, `stderr`) must be synchronous functions even with async SDK
-- In example files, focus on the `recipe` function body for SDK usage patterns; ignore test harness files (`_harness.py`, `registry.py`, `types.py`)
+- In example files, focus on the `recipe` function body for SDK usage patterns; ignore test harness files (`_harness.py`, `registry.py`, `example_types.py`)
 
 ## Async vs Sync
 

llms.txt

@@ -23,7 +23,7 @@
 LLMS_FILE = ROOT / "llms.txt"
 
 REQUIRED_FIELDS = ["title", "slug", "use_case", "workflow", "tags", "prerequisites", "run", "test"]
-EXCLUDED_FILES = {"_harness.py", "types.py", "registry.py", "__init__.py"}
+EXCLUDED_FILES = {"_harness.py", "example_types.py", "registry.py", "__init__.py"}
 
 
 def parse_example(path: Path) -> dict[str, Any]:
@@ -64,8 +64,9 @@ def validate_example(metadata: dict[str, Any], file_name: str, seen_slugs: set[s
         raise ValueError(f"{path}: duplicate slug")
     seen_slugs.add(slug)
 
-    if f"examples/{file_name}" not in metadata["run"]:
-        raise ValueError(f"{path}: run command must reference the file")
+    module_name = file_name.replace(".py", "")
+    if f"examples.{module_name}" not in metadata["run"]:
+        raise ValueError(f"{path}: run command must reference 'examples.{module_name}'")
 
 
 def ensure_llms_references(examples: list[dict[str, Any]]) -> None:
@@ -180,7 +181,7 @@ def generate_registry(examples: list[dict[str, Any]]) -> str:
 
 from typing import Any, Callable, cast
 
-from .types import ExampleResult
+from .example_types import ExampleResult
 {chr(10).join(imports)}
 
 ExampleRegistryEntry = dict[str, Any]

scripts/generate_examples_md.py

@@ -16,8 +16,8 @@
 # Add the root directory to the path so we can import examples
 sys.path.insert(0, str(Path(__file__).parents[3]))
 
-from examples.types import ExampleResult  # noqa: E402
 from examples.registry import example_registry  # noqa: E402
+from examples.example_types import ExampleResult  # noqa: E402
 from examples.mcp_github_tools import McpExampleOptions, run_mcp_github_tools_example  # noqa: E402
 
 LONG_TIMEOUT = 600  # 10 minutes for live tests