batrachian-toad 0.5.22__py3-none-any.whl

toad/agent.py

@@ -0,0 +1,62 @@
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from pathlib import Path
+
+from textual.content import Content
+from textual.message import Message
+
+
+class AgentReady(Message):
+    """Agent is ready."""
+
+
+@dataclass
+class AgentFail(Message):
+    """Agent failed to start."""
+
+    message: str
+    details: str = ""
+
+
+class AgentBase(ABC):
+    """Base class for an 'agent'."""
+
+    def __init__(self, project_root: Path) -> None:
+        self.project_root_path = project_root
+        super().__init__()
+
+    @abstractmethod
+    async def send_prompt(self, prompt: str) -> str | None:
+        """Send a prompt to the agent.
+
+        Args:
+            prompt: Prompt text.
+
+        Returns:
+            str: The stop reason.
+        """
+
+    async def set_mode(self, mode_id: str) -> str | None:
+        """Put the agent in a new mode.
+
+        Args:
+            mode_id: Mode id.
+
+        Returns:
+            str: The stop reason.
+        """
+
+    async def cancel(self) -> bool:
+        """Cancel prompt.
+
+        Returns:
+            bool: `True` if success, `False` if the turn wasn't cancelled.
+
+        """
+        return False
+
+    def get_info(self) -> Content:
+        return Content("")
+
+    async def stop(self) -> None:
+        """Stop the agent (gracefully exit the process)"""

toad/agent_schema.py

@@ -0,0 +1,70 @@
+from typing import TypedDict, Literal, NotRequired
+
+type Tag = str
+"""A tag used for categorizing the agent. For example: 'open-source', 'reasoning'."""
+type OS = Literal["macos", "linux", "windows", "*"]
+"""An operating system identifier, or a '*" wildcard, if it is the same for all OSes."""
+type Action = str
+"""An action which the agent supports."""
+type AgentType = Literal["coding", "chat"]
+"""The type of agent. More types TBD."""
+type AgentProtocol = Literal["acp"]
+"""The protocol used to communicate with the agent. Currently only "acp" is supported."""
+
+
+class Command(TypedDict):
+    """Used to perform an action associate with an Agent."""
+
+    description: str
+    """Describes what the script will do. For example: 'Install Claude Code'."""
+    command: str
+    """Command to run."""
+    bootstrap_uv: NotRequired[bool]
+    """Bootstrap UV installer (set to `true` if the command users `uv`)."""
+
+
+class Agent(TypedDict):
+    """Describes an agent which Toad can connect to. Currently only Agent Client Protocol is supported.
+
+    This information is stoed within TOML files, where the filename is the "identity" key plus the extension ".toml"
+
+    """
+
+    active: NotRequired[bool]
+    """If `True` (default), the agent will be shown in the UI. If `False` the agent will be removed from the UI."""
+    recommended: NotRequired[bool]
+    """Agent is in recommended set. Set to `True` in main branch only if previously agreed with Will McGugan."""
+    identity: str
+    """A unique identifier for this agent. Should be a domain the agent developer owns,
+    although it doesn't have to resolve to anything. Must be useable in a filename on all platforms. 
+    For example: 'claude.anthropic.ai'"""
+    name: str
+    """The name of the agent. For example: 'Claude Code'."""
+    short_name: str
+    """A short name, usable on the command line. Try to make it unique. For example: 'claude'."""
+    url: str
+    """A URL for the agent."""
+    protocol: AgentProtocol
+    """The protocol used by the agent. Currently only 'acp' is supported."""
+    type: "AgentType"
+    """The type of the agent. Currently "coding" or "chat". More types TBD."""
+    author_name: str
+    """The author of the agent. For example 'Anthropic'."""
+    author_url: str
+    """The authors homepage. For example 'https://www.anthropic.com/'."""
+    publisher_name: str
+    """The publisher's name (individual or organization that wrote this data)."""
+    publisher_url: str
+    """The publisher's url."""
+    description: str
+    """A description of the agent. A few sentences max. May contain content markup (https://textual.textualize.io/guide/content/#markup) if used subtly."""
+    tags: list[Tag]
+    """Tags which identify the agent. Should be empty for now."""
+    help: str
+    """A Markdown document with additional details regarding the agent."""
+    welcome: NotRequired[str]
+    """A Markdown document shown to the user when the conversation starts. Should contain a welcome message and any advice on getting started."""
+    run_command: dict[OS, str]
+    """Command to run the agent, by OS or wildcard."""
+    actions: dict[OS, dict[Action, Command]]
+    """Scripts to perform actions, typically at least to install the agent."""

toad/agents.py

@@ -0,0 +1,45 @@
+from importlib.resources import files
+import asyncio
+
+from toad.agent_schema import Agent
+
+
+class AgentReadError(Exception):
+    """Problem reading the agents."""
+
+
+async def read_agents() -> dict[str, Agent]:
+    """Read agent information from data/agents
+
+    Raises:
+        AgentReadError: If the files could not be read.
+
+    Returns:
+        A mapping of identity on to Agent dict.
+    """
+    import tomllib
+
+    def read_agents() -> list[Agent]:
+        """Read agent information.
+
+        Stored in data/agents
+
+        Returns:
+            List of agent dicts.
+        """
+        agents: list[Agent] = []
+        try:
+            for file in files("toad.data").joinpath("agents").iterdir():
+                agent: Agent = tomllib.load(file.open("rb"))
+                if agent.get("active", True):
+                    agents.append(agent)
+
+        except Exception as error:
+            raise AgentReadError(f"Failed to read agents; {error}")
+
+        return agents
+
+    agents = await asyncio.to_thread(read_agents)
+    agent_map = {agent["identity"]: agent for agent in agents}
+
+    return agent_map

toad/ansi/__init__.py

@@ -0,0 +1 @@
+from toad.ansi._ansi import TerminalState as TerminalState