add example docs to python agent stuff

Author: jrvb-rl

src/runloop_api_client/sdk/agent.py

@@ -13,7 +13,19 @@
 
 
 class Agent:
-    """Wrapper around synchronous agent operations."""
+    """Wrapper around synchronous agent operations.
+
+    This class provides a Pythonic interface for interacting with agents,
+    including retrieving agent information.
+
+    Example:
+        >>> agent = runloop.agent.create_from_npm(
+        ...     name="my-agent",
+        ...     package_name="@runloop/example-agent"
+        ... )
+        >>> info = agent.get_info()
+        >>> print(info.name)
+    """
 
     def __init__(
         self,

src/runloop_api_client/sdk/async_.py

@@ -549,11 +549,22 @@ class AsyncAgentOps:
     """High-level async manager for creating and managing agents.
 
     Accessed via ``runloop.agent`` from :class:`AsyncRunloopSDK`, provides
-    coroutines to create, retrieve, and list agents.
+    coroutines to create, retrieve, and list agents from various sources (npm, pip, git, object storage).
 
     Example:
         >>> runloop = AsyncRunloopSDK()
-        >>> agent = await runloop.agent.create(name="my-agent")
+        >>> # Create agent from NPM package
+        >>> agent = await runloop.agent.create_from_npm(
+        ...     name="my-agent",
+        ...     package_name="@runloop/example-agent"
+        ... )
+        >>> # Create agent from Git repository
+        >>> agent = await runloop.agent.create_from_git(
+        ...     name="git-agent",
+        ...     repository="https://github.com/user/agent-repo",
+        ...     ref="main"
+        ... )
+        >>> # List all agents
         >>> agents = await runloop.agent.list(limit=10)
     """
 

src/runloop_api_client/sdk/async_agent.py

@@ -13,7 +13,19 @@
 
 
 class AsyncAgent:
-    """Async wrapper around agent operations."""
+    """Async wrapper around agent operations.
+
+    This class provides an asynchronous interface for interacting with agents,
+    including retrieving agent information.
+
+    Example:
+        >>> agent = await runloop.agent.create_from_npm(
+        ...     name="my-agent",
+        ...     package_name="@runloop/example-agent"
+        ... )
+        >>> info = await agent.get_info()
+        >>> print(info.name)
+    """
 
     def __init__(
         self,

src/runloop_api_client/sdk/async_devbox.py

@@ -54,7 +54,7 @@ class AsyncDevbox:
     management.
 
     Example:
-        >>> devbox = await sdk.devbox.create(name="my-devbox")
+        >>> devbox = await runloop.devbox.create(name="my-devbox")
         >>> async with devbox:
         ...     result = await devbox.cmd.exec("echo 'hello'")
         ...     print(await result.stdout())

src/runloop_api_client/sdk/devbox.py

@@ -54,7 +54,7 @@ class Devbox:
     The Devbox class supports context manager protocol for automatic cleanup.
 
     Example:
-        >>> with sdk.devbox.create(name="my-devbox") as devbox:
+        >>> with runloop.devbox.create(name="my-devbox") as devbox:
         ...     result = devbox.cmd.exec("echo 'hello'")
         ...     print(result.stdout())
         # Devbox is automatically shutdown on exit

src/runloop_api_client/sdk/sync.py

@@ -545,11 +545,22 @@ class AgentOps:
     """High-level manager for creating and managing agents.
 
     Accessed via ``runloop.agent`` from :class:`RunloopSDK`, provides methods to
-    create, retrieve, and list agents.
+    create, retrieve, and list agents from various sources (npm, pip, git, object storage).
 
     Example:
         >>> runloop = RunloopSDK()
-        >>> agent = runloop.agent.create(name="my-agent")
+        >>> # Create agent from NPM package
+        >>> agent = runloop.agent.create_from_npm(
+        ...     name="my-agent",
+        ...     package_name="@runloop/example-agent"
+        ... )
+        >>> # Create agent from Git repository
+        >>> agent = runloop.agent.create_from_git(
+        ...     name="git-agent",
+        ...     repository="https://github.com/user/agent-repo",
+        ...     ref="main"
+        ... )
+        >>> # List all agents
         >>> agents = runloop.agent.list(limit=10)
     """
 
@@ -587,6 +598,13 @@ def create_from_npm(
     ) -> Agent:
         """Create an agent from an NPM package.
 
+        Example:
+            >>> agent = runloop.agent.create_from_npm(
+            ...     name="my-npm-agent",
+            ...     package_name="@runloop/example-agent",
+            ...     npm_version="^1.0.0"
+            ... )
+
         :param package_name: NPM package name
         :type package_name: str
         :param npm_version: NPM version constraint, defaults to None
@@ -627,6 +645,13 @@ def create_from_pip(
     ) -> Agent:
         """Create an agent from a Pip package.
 
+        Example:
+            >>> agent = runloop.agent.create_from_pip(
+            ...     name="my-pip-agent",
+            ...     package_name="runloop-example-agent",
+            ...     pip_version=">=1.0.0"
+            ... )
+
         :param package_name: Pip package name
         :type package_name: str
         :param pip_version: Pip version constraint, defaults to None
@@ -666,6 +691,14 @@ def create_from_git(
     ) -> Agent:
         """Create an agent from a Git repository.
 
+        Example:
+            >>> agent = runloop.agent.create_from_git(
+            ...     name="my-git-agent",
+            ...     repository="https://github.com/user/agent-repo",
+            ...     ref="main",
+            ...     agent_setup=["npm install", "npm run build"]
+            ... )
+
         :param repository: Git repository URL
         :type repository: str
         :param ref: Optional Git ref (branch/tag/commit), defaults to main/HEAD
@@ -700,6 +733,16 @@ def create_from_object(
     ) -> Agent:
         """Create an agent from a storage object.
 
+        Example:
+            >>> # First upload agent code as an object
+            >>> obj = runloop.storage_object.upload_from_dir("./my-agent")
+            >>> # Then create agent from the object
+            >>> agent = runloop.agent.create_from_object(
+            ...     name="my-object-agent",
+            ...     object_id=obj.id,
+            ...     agent_setup=["chmod +x setup.sh", "./setup.sh"]
+            ... )
+
         :param object_id: Storage object ID
         :type object_id: str
         :param agent_setup: Setup commands to run after unpacking, defaults to None