Building AI agents, atomically
Add docs
KennyVaneetvelde24a94afd0f8a
diff --git a/README.md b/README.mdindex 7efdb80..7491e19 100644--- a/README.md+++ b/README.md@@ -93,6 +93,9 @@ After running this command you should be presented with a menu, allowing you to## Provider & Model CompatibilityAtomic Agents depends on the [Instructor](https://github.com/jxnl/instructor) package. This means that in all examples where OpenAI is used, any other API supported by Instructor can be used, such as Ollama, Groq, Mistral, Cohere, Anthropic, Gemini, and more. For a complete list please refer to the instructor documentation on its [GitHub page](https://github.com/jxnl/instructor).+## API Documentation+API documentation can be found [here](https://brainblend-ai.github.io/atomic-agents/).+## ContributingWe welcome contributions! Please follow these steps to contribute:diff --git a/docs/agents/base_agent.html b/docs/agents/base_agent.htmlnew file mode 100644index 0000000..94b2efd--- /dev/null+++ b/docs/agents/base_agent.html@@ -0,0 +1,560 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.agents.base_agent API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.agents.base_agent</code></h1>+</header>+<section id="section-intro">+</section>+<section>+</section>+<section>+</section>+<section>+</section>+<section>+<h2 class="section-title" id="header-classes">Classes</h2>+<dl>+<dt id="atomic_agents.agents.base_agent.BaseAgent"><code class="flex name class">+<span>class <span class="ident">BaseAgent</span></span>+<span>(</span><span>config: <a title="atomic_agents.agents.base_agent.BaseAgentConfig" href="#atomic_agents.agents.base_agent.BaseAgentConfig">BaseAgentConfig</a>)</span>+</code></dt>+<dd>+<div class="desc"><p>Base class for chat agents.</p>+<p>This class provides the core functionality for handling chat interactions, including managing memory,+generating system prompts, and obtaining responses from a language model.</p>+<h2 id="attributes">Attributes</h2>+<dl>+<dt><strong><code>input_schema</code></strong> : <code>Type[BaseIOSchema]</code></dt>+<dd>Schema for the input data.</dd>+<dt><strong><code>output_schema</code></strong> : <code>Type[BaseIOSchema]</code></dt>+<dd>Schema for the output data.</dd>+<dt><strong><code>client</code></strong></dt>+<dd>Client for interacting with the language model.</dd>+<dt><strong><code>model</code></strong> : <code>str</code></dt>+<dd>The model to use for generating responses.</dd>+<dt><strong><code>memory</code></strong> : <code>AgentMemory</code></dt>+<dd>Memory component for storing chat history.</dd>+<dt><strong><code>system_prompt_generator</code></strong> : <code>SystemPromptGenerator</code></dt>+<dd>Component for generating system prompts.</dd>+<dt><strong><code>initial_memory</code></strong> : <code>AgentMemory</code></dt>+<dd>Initial state of the memory.</dd>+</dl>+<p>Initializes the BaseAgent.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>config</code></strong> : <code><a title="atomic_agents.agents.base_agent.BaseAgentConfig" href="#atomic_agents.agents.base_agent.BaseAgentConfig">BaseAgentConfig</a></code></dt>+<dd>Configuration for the chat agent.</dd>+</dl></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class BaseAgent:+ """+ Base class for chat agents.++ This class provides the core functionality for handling chat interactions, including managing memory,+ generating system prompts, and obtaining responses from a language model.++ Attributes:+ input_schema (Type[BaseIOSchema]): Schema for the input data.+ output_schema (Type[BaseIOSchema]): Schema for the output data.+ client: Client for interacting with the language model.+ model (str): The model to use for generating responses.+ memory (AgentMemory): Memory component for storing chat history.+ system_prompt_generator (SystemPromptGenerator): Component for generating system prompts.+ initial_memory (AgentMemory): Initial state of the memory.+ """++ input_schema = BaseAgentInputSchema+ output_schema = BaseAgentOutputSchema++ def __init__(self, config: BaseAgentConfig):+ """+ Initializes the BaseAgent.++ Args:+ config (BaseAgentConfig): Configuration for the chat agent.+ """+ self.input_schema = config.input_schema or self.input_schema+ self.output_schema = config.output_schema or self.output_schema+ self.client = config.client+ self.model = config.model+ self.memory = config.memory or AgentMemory()+ self.system_prompt_generator = config.system_prompt_generator or SystemPromptGenerator()+ self.initial_memory = self.memory.copy()+ self.current_user_input = None++ def reset_memory(self):+ """+ Resets the memory to its initial state.+ """+ self.memory = self.initial_memory.copy()++ def get_response(self, response_model=None) -> Type[BaseModel]:+ """+ Obtains a response from the language model.++ Args:+ response_model (Type[BaseModel], optional):+ The schema for the response data. If not set, self.output_schema is used.++ Returns:+ Type[BaseModel]: The response from the language model.+ """+ if response_model is None:+ response_model = self.output_schema++ messages = [+ {+ "role": "system",+ "content": self.system_prompt_generator.generate_prompt(),+ }+ ] + self.memory.get_history()+ response = self.client.chat.completions.create(model=self.model, messages=messages, response_model=response_model)+ return response++ def run(self, user_input: Optional[Type[BaseIOSchema]] = None) -> Type[BaseIOSchema]:+ """+ Runs the chat agent with the given user input.++ Args:+ user_input (Optional[Type[BaseIOSchema]]): The input from the user. If not provided, skips adding to memory.++ Returns:+ Type[BaseIOSchema]: The response from the chat agent.+ """+ if user_input:+ self.memory.initialize_turn()+ self.current_user_input = user_input+ self.memory.add_message("user", user_input)++ response = self.get_response(response_model=self.output_schema)+ self.memory.add_message("assistant", response)++ return response++ def get_context_provider(self, provider_name: str) -> Type[SystemPromptContextProviderBase]:+ """+ Retrieves a context provider by name.++ Args:+ provider_name (str): The name of the context provider.++ Returns:+ SystemPromptContextProviderBase: The context provider if found.++ Raises:+ KeyError: If the context provider is not found.+ """+ if provider_name not in self.system_prompt_generator.context_providers:+ raise KeyError(f"Context provider '{provider_name}' not found.")+ return self.system_prompt_generator.context_providers[provider_name]++ def register_context_provider(self, provider_name: str, provider: SystemPromptContextProviderBase):+ """+ Registers a new context provider.++ Args:+ provider_name (str): The name of the context provider.+ provider (SystemPromptContextProviderBase): The context provider instance.+ """+ self.system_prompt_generator.context_providers[provider_name] = provider++ def unregister_context_provider(self, provider_name: str):+ """+ Unregisters an existing context provider.++ Args:+ provider_name (str): The name of the context provider to remove.+ """+ if provider_name in self.system_prompt_generator.context_providers:+ del self.system_prompt_generator.context_providers[provider_name]+ else:+ raise KeyError(f"Context provider '{provider_name}' not found.")</code></pre>+</details>+<h3>Class variables</h3>+<dl>+<dt id="atomic_agents.agents.base_agent.BaseAgent.input_schema"><code class="name">var <span class="ident">input_schema</span></code></dt>+<dd>+<div class="desc"><p>This schema represents the input from the user to the AI agent.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgent.output_schema"><code class="name">var <span class="ident">output_schema</span></code></dt>+<dd>+<div class="desc"><p>This schema represents the response generated by the chat agent.</p></div>+</dd>+</dl>+<h3>Methods</h3>+<dl>+<dt id="atomic_agents.agents.base_agent.BaseAgent.get_context_provider"><code class="name flex">+<span>def <span class="ident">get_context_provider</span></span>(<span>self, provider_name: str) ‑> Type[<a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase" href="../lib/components/system_prompt_generator.html#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase">SystemPromptContextProviderBase</a>]</span>+</code></dt>+<dd>+<div class="desc"><p>Retrieves a context provider by name.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>provider_name</code></strong> : <code>str</code></dt>+<dd>The name of the context provider.</dd>+</dl>+<h2 id="returns">Returns</h2>+<dl>+<dt><code>SystemPromptContextProviderBase</code></dt>+<dd>The context provider if found.</dd>+</dl>+<h2 id="raises">Raises</h2>+<dl>+<dt><code>KeyError</code></dt>+<dd>If the context provider is not found.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgent.get_response"><code class="name flex">+<span>def <span class="ident">get_response</span></span>(<span>self, response_model=None) ‑> Type[pydantic.main.BaseModel]</span>+</code></dt>+<dd>+<div class="desc"><p>Obtains a response from the language model.</p>+<h2 id="args">Args</h2>+<p>response_model (Type[BaseModel], optional):+The schema for the response data. If not set, self.output_schema is used.</p>+<h2 id="returns">Returns</h2>+<dl>+<dt><code>Type[BaseModel]</code></dt>+<dd>The response from the language model.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgent.register_context_provider"><code class="name flex">+<span>def <span class="ident">register_context_provider</span></span>(<span>self, provider_name: str, provider: <a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase" href="../lib/components/system_prompt_generator.html#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase">SystemPromptContextProviderBase</a>)</span>+</code></dt>+<dd>+<div class="desc"><p>Registers a new context provider.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>provider_name</code></strong> : <code>str</code></dt>+<dd>The name of the context provider.</dd>+<dt><strong><code>provider</code></strong> : <code>SystemPromptContextProviderBase</code></dt>+<dd>The context provider instance.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgent.reset_memory"><code class="name flex">+<span>def <span class="ident">reset_memory</span></span>(<span>self)</span>+</code></dt>+<dd>+<div class="desc"><p>Resets the memory to its initial state.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgent.run"><code class="name flex">+<span>def <span class="ident">run</span></span>(<span>self, user_input: Optional[Type[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>]] = None) ‑> Type[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>]</span>+</code></dt>+<dd>+<div class="desc"><p>Runs the chat agent with the given user input.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>user_input</code></strong> : <code>Optional[Type[BaseIOSchema]]</code></dt>+<dd>The input from the user. If not provided, skips adding to memory.</dd>+</dl>+<h2 id="returns">Returns</h2>+<dl>+<dt><code>Type[BaseIOSchema]</code></dt>+<dd>The response from the chat agent.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgent.unregister_context_provider"><code class="name flex">+<span>def <span class="ident">unregister_context_provider</span></span>(<span>self, provider_name: str)</span>+</code></dt>+<dd>+<div class="desc"><p>Unregisters an existing context provider.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>provider_name</code></strong> : <code>str</code></dt>+<dd>The name of the context provider to remove.</dd>+</dl></div>+</dd>+</dl>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig"><code class="flex name class">+<span>class <span class="ident">BaseAgentConfig</span></span>+<span>(</span><span>**data: Any)</span>+</code></dt>+<dd>+<div class="desc"><p>Usage docs: <a href="https://docs.pydantic.dev/2.9/concepts/models/">https://docs.pydantic.dev/2.9/concepts/models/</a></p>+<p>A base class for creating Pydantic models.</p>+<h2 id="attributes">Attributes</h2>+<dl>+<dt><strong><code>__class_vars__</code></strong></dt>+<dd>The names of the class variables defined on the model.</dd>+<dt><strong><code>__private_attributes__</code></strong></dt>+<dd>Metadata about the private attributes of the model.</dd>+<dt><strong><code>__signature__</code></strong></dt>+<dd>The synthesized <code>__init__</code> [<code>Signature</code>][inspect.Signature] of the model.</dd>+<dt><strong><code>__pydantic_complete__</code></strong></dt>+<dd>Whether model building is completed, or if there are still undefined fields.</dd>+<dt><strong><code>__pydantic_core_schema__</code></strong></dt>+<dd>The core schema of the model.</dd>+<dt><strong><code>__pydantic_custom_init__</code></strong></dt>+<dd>Whether the model has a custom <code>__init__</code> function.</dd>+<dt><strong><code>__pydantic_decorators__</code></strong></dt>+<dd>Metadata containing the decorators defined on the model.+This replaces <code>Model.__validators__</code> and <code>Model.__root_validators__</code> from Pydantic V1.</dd>+<dt><strong><code>__pydantic_generic_metadata__</code></strong></dt>+<dd>Metadata for generic models; contains data used for a similar purpose to+<strong>args</strong>, <strong>origin</strong>, <strong>parameters</strong> in typing-module generics. May eventually be replaced by these.</dd>+<dt><strong><code>__pydantic_parent_namespace__</code></strong></dt>+<dd>Parent namespace of the model, used for automatic rebuilding of models.</dd>+<dt><strong><code>__pydantic_post_init__</code></strong></dt>+<dd>The name of the post-init method for the model, if defined.</dd>+<dt><strong><code>__pydantic_root_model__</code></strong></dt>+<dd>Whether the model is a [<code>RootModel</code>][pydantic.root_model.RootModel].</dd>+<dt><strong><code>__pydantic_serializer__</code></strong></dt>+<dd>The <code>pydantic-core</code> <code>SchemaSerializer</code> used to dump instances of the model.</dd>+<dt><strong><code>__pydantic_validator__</code></strong></dt>+<dd>The <code>pydantic-core</code> <code>SchemaValidator</code> used to validate instances of the model.</dd>+<dt><strong><code>__pydantic_extra__</code></strong></dt>+<dd>A dictionary containing extra values, if [<code>extra</code>][pydantic.config.ConfigDict.extra]+is set to <code>'allow'</code>.</dd>+<dt><strong><code>__pydantic_fields_set__</code></strong></dt>+<dd>The names of fields explicitly set during instantiation.</dd>+<dt><strong><code>__pydantic_private__</code></strong></dt>+<dd>Values of private attributes set on the model instance.</dd>+</dl>+<p>Create a new model by parsing and validating input data from keyword arguments.</p>+<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be+validated to form a valid model.</p>+<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class BaseAgentConfig(BaseModel):+ client: instructor.client.Instructor = Field(..., description="Client for interacting with the language model.")+ model: str = Field("gpt-4o-mini", description="The model to use for generating responses.")+ memory: Optional[AgentMemory] = Field(None, description="Memory component for storing chat history.")+ system_prompt_generator: Optional[SystemPromptGenerator] = Field(+ None, description="Component for generating system prompts."+ )+ input_schema: Optional[Type[BaseModel]] = Field(None, description="The schema for the input data.")+ output_schema: Optional[Type[BaseModel]] = Field(None, description="The schema for the output data.")++ model_config = {"arbitrary_types_allowed": True}</code></pre>+</details>+<h3>Ancestors</h3>+<ul class="hlist">+<li>pydantic.main.BaseModel</li>+</ul>+<h3>Class variables</h3>+<dl>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.client"><code class="name">var <span class="ident">client</span> : instructor.client.Instructor</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.input_schema"><code class="name">var <span class="ident">input_schema</span> : Optional[Type[pydantic.main.BaseModel]]</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.memory"><code class="name">var <span class="ident">memory</span> : Optional[<a title="atomic_agents.lib.components.agent_memory.AgentMemory" href="../lib/components/agent_memory.html#atomic_agents.lib.components.agent_memory.AgentMemory">AgentMemory</a>]</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.model"><code class="name">var <span class="ident">model</span> : str</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.model_computed_fields"><code class="name">var <span class="ident">model_computed_fields</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.model_fields"><code class="name">var <span class="ident">model_fields</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.output_schema"><code class="name">var <span class="ident">output_schema</span> : Optional[Type[pydantic.main.BaseModel]]</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentConfig.system_prompt_generator"><code class="name">var <span class="ident">system_prompt_generator</span> : Optional[<a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator" href="../lib/components/system_prompt_generator.html#atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator">SystemPromptGenerator</a>]</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+</dl>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentInputSchema"><code class="flex name class">+<span>class <span class="ident">BaseAgentInputSchema</span></span>+<span>(</span><span>**data: Any)</span>+</code></dt>+<dd>+<div class="desc"><p>This schema represents the input from the user to the AI agent.</p>+<p>Create a new model by parsing and validating input data from keyword arguments.</p>+<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be+validated to form a valid model.</p>+<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class BaseAgentInputSchema(BaseIOSchema):+ """This schema represents the input from the user to the AI agent."""++ chat_message: str = Field(+ ...,+ description="The chat message sent by the user to the assistant.",+ )</code></pre>+</details>+<h3>Ancestors</h3>+<ul class="hlist">+<li><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></li>+<li>pydantic.main.BaseModel</li>+</ul>+<h3>Class variables</h3>+<dl>+<dt id="atomic_agents.agents.base_agent.BaseAgentInputSchema.chat_message"><code class="name">var <span class="ident">chat_message</span> : str</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+</dl>+<h3>Inherited members</h3>+<ul class="hlist">+<li><code><b><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></b></code>:+<ul class="hlist">+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_computed_fields" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_computed_fields">model_computed_fields</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config">model_config</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_fields" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_fields">model_fields</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema">model_json_schema</a></code></li>+</ul>+</li>+</ul>+</dd>+<dt id="atomic_agents.agents.base_agent.BaseAgentOutputSchema"><code class="flex name class">+<span>class <span class="ident">BaseAgentOutputSchema</span></span>+<span>(</span><span>**data: Any)</span>+</code></dt>+<dd>+<div class="desc"><p>This schema represents the response generated by the chat agent.</p>+<p>Create a new model by parsing and validating input data from keyword arguments.</p>+<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be+validated to form a valid model.</p>+<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class BaseAgentOutputSchema(BaseIOSchema):+ """This schema represents the response generated by the chat agent."""++ chat_message: str = Field(+ ...,+ description=(+ "The chat message exchanged between the user and the chat agent. "+ "This contains the markdown-enabled response generated by the chat agent."+ ),+ )</code></pre>+</details>+<h3>Ancestors</h3>+<ul class="hlist">+<li><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></li>+<li>pydantic.main.BaseModel</li>+</ul>+<h3>Class variables</h3>+<dl>+<dt id="atomic_agents.agents.base_agent.BaseAgentOutputSchema.chat_message"><code class="name">var <span class="ident">chat_message</span> : str</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+</dl>+<h3>Inherited members</h3>+<ul class="hlist">+<li><code><b><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></b></code>:+<ul class="hlist">+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_computed_fields" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_computed_fields">model_computed_fields</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config">model_config</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_fields" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_fields">model_fields</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema" href="../lib/base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema">model_json_schema</a></code></li>+</ul>+</li>+</ul>+</dd>+</dl>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents.agents" href="index.html">atomic_agents.agents</a></code></li>+</ul>+</li>+<li><h3><a href="#header-classes">Classes</a></h3>+<ul>+<li>+<h4><code><a title="atomic_agents.agents.base_agent.BaseAgent" href="#atomic_agents.agents.base_agent.BaseAgent">BaseAgent</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.get_context_provider" href="#atomic_agents.agents.base_agent.BaseAgent.get_context_provider">get_context_provider</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.get_response" href="#atomic_agents.agents.base_agent.BaseAgent.get_response">get_response</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.input_schema" href="#atomic_agents.agents.base_agent.BaseAgent.input_schema">input_schema</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.output_schema" href="#atomic_agents.agents.base_agent.BaseAgent.output_schema">output_schema</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.register_context_provider" href="#atomic_agents.agents.base_agent.BaseAgent.register_context_provider">register_context_provider</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.reset_memory" href="#atomic_agents.agents.base_agent.BaseAgent.reset_memory">reset_memory</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.run" href="#atomic_agents.agents.base_agent.BaseAgent.run">run</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgent.unregister_context_provider" href="#atomic_agents.agents.base_agent.BaseAgent.unregister_context_provider">unregister_context_provider</a></code></li>+</ul>+</li>+<li>+<h4><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig" href="#atomic_agents.agents.base_agent.BaseAgentConfig">BaseAgentConfig</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.client" href="#atomic_agents.agents.base_agent.BaseAgentConfig.client">client</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.input_schema" href="#atomic_agents.agents.base_agent.BaseAgentConfig.input_schema">input_schema</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.memory" href="#atomic_agents.agents.base_agent.BaseAgentConfig.memory">memory</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.model" href="#atomic_agents.agents.base_agent.BaseAgentConfig.model">model</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.model_computed_fields" href="#atomic_agents.agents.base_agent.BaseAgentConfig.model_computed_fields">model_computed_fields</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.model_config" href="#atomic_agents.agents.base_agent.BaseAgentConfig.model_config">model_config</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.model_fields" href="#atomic_agents.agents.base_agent.BaseAgentConfig.model_fields">model_fields</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.output_schema" href="#atomic_agents.agents.base_agent.BaseAgentConfig.output_schema">output_schema</a></code></li>+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentConfig.system_prompt_generator" href="#atomic_agents.agents.base_agent.BaseAgentConfig.system_prompt_generator">system_prompt_generator</a></code></li>+</ul>+</li>+<li>+<h4><code><a title="atomic_agents.agents.base_agent.BaseAgentInputSchema" href="#atomic_agents.agents.base_agent.BaseAgentInputSchema">BaseAgentInputSchema</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentInputSchema.chat_message" href="#atomic_agents.agents.base_agent.BaseAgentInputSchema.chat_message">chat_message</a></code></li>+</ul>+</li>+<li>+<h4><code><a title="atomic_agents.agents.base_agent.BaseAgentOutputSchema" href="#atomic_agents.agents.base_agent.BaseAgentOutputSchema">BaseAgentOutputSchema</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.agents.base_agent.BaseAgentOutputSchema.chat_message" href="#atomic_agents.agents.base_agent.BaseAgentOutputSchema.chat_message">chat_message</a></code></li>+</ul>+</li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/agents/index.html b/docs/agents/index.htmlnew file mode 100644index 0000000..9dcf756--- /dev/null+++ b/docs/agents/index.html@@ -0,0 +1,67 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.agents API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.agents</code></h1>+</header>+<section id="section-intro">+</section>+<section>+<h2 class="section-title" id="header-submodules">Sub-modules</h2>+<dl>+<dt><code class="name"><a title="atomic_agents.agents.base_agent" href="base_agent.html">atomic_agents.agents.base_agent</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+</dl>+</section>+<section>+</section>+<section>+</section>+<section>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents" href="../index.html">atomic_agents</a></code></li>+</ul>+</li>+<li><h3><a href="#header-submodules">Sub-modules</a></h3>+<ul>+<li><code><a title="atomic_agents.agents.base_agent" href="base_agent.html">atomic_agents.agents.base_agent</a></code></li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/index.html b/docs/index.htmlnew file mode 100644index 0000000..de14e9d--- /dev/null+++ b/docs/index.html@@ -0,0 +1,67 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Namespace <code>atomic_agents</code></h1>+</header>+<section id="section-intro">+</section>+<section>+<h2 class="section-title" id="header-submodules">Sub-modules</h2>+<dl>+<dt><code class="name"><a title="atomic_agents.agents" href="agents/index.html">atomic_agents.agents</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+<dt><code class="name"><a title="atomic_agents.lib" href="lib/index.html">atomic_agents.lib</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+</dl>+</section>+<section>+</section>+<section>+</section>+<section>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3><a href="#header-submodules">Sub-modules</a></h3>+<ul>+<li><code><a title="atomic_agents.agents" href="agents/index.html">atomic_agents.agents</a></code></li>+<li><code><a title="atomic_agents.lib" href="lib/index.html">atomic_agents.lib</a></code></li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/lib/base/base_io_schema.html b/docs/lib/base/base_io_schema.htmlnew file mode 100644index 0000000..2750a58--- /dev/null+++ b/docs/lib/base/base_io_schema.html@@ -0,0 +1,165 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.lib.base.base_io_schema API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.lib.base.base_io_schema</code></h1>+</header>+<section id="section-intro">+</section>+<section>+</section>+<section>+</section>+<section>+</section>+<section>+<h2 class="section-title" id="header-classes">Classes</h2>+<dl>+<dt id="atomic_agents.lib.base.base_io_schema.BaseIOSchema"><code class="flex name class">+<span>class <span class="ident">BaseIOSchema</span></span>+<span>(</span><span>**data: Any)</span>+</code></dt>+<dd>+<div class="desc"><p>Base schema for input/output in the Atomic Agents framework.</p>+<p>Create a new model by parsing and validating input data from keyword arguments.</p>+<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be+validated to form a valid model.</p>+<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class BaseIOSchema(BaseModel):+ """Base schema for input/output in the Atomic Agents framework."""++ def __str__(self):+ return self.model_dump_json()++ def __rich__(self):+ json_str = self.model_dump_json()+ return JSON(json_str)++ @classmethod+ def __pydantic_init_subclass__(cls, **kwargs):+ super().__pydantic_init_subclass__(**kwargs)+ cls._validate_description()++ @classmethod+ def _validate_description(cls):+ description = cls.__doc__++ if not description or not description.strip():+ if cls.__module__ != "instructor.function_calls":+ raise ValueError(f"{cls.__name__} must have a non-empty docstring to serve as its description")++ @classmethod+ def model_json_schema(cls, *args, **kwargs):+ schema = super().model_json_schema(*args, **kwargs)+ if "description" not in schema and cls.__doc__:+ schema["description"] = inspect.cleandoc(cls.__doc__)+ if "title" not in schema:+ schema["title"] = cls.__name__+ return schema</code></pre>+</details>+<h3>Ancestors</h3>+<ul class="hlist">+<li>pydantic.main.BaseModel</li>+</ul>+<h3>Subclasses</h3>+<ul class="hlist">+<li><a title="atomic_agents.agents.base_agent.BaseAgentInputSchema" href="../../agents/base_agent.html#atomic_agents.agents.base_agent.BaseAgentInputSchema">BaseAgentInputSchema</a></li>+<li><a title="atomic_agents.agents.base_agent.BaseAgentOutputSchema" href="../../agents/base_agent.html#atomic_agents.agents.base_agent.BaseAgentOutputSchema">BaseAgentOutputSchema</a></li>+</ul>+<h3>Class variables</h3>+<dl>+<dt id="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_computed_fields"><code class="name">var <span class="ident">model_computed_fields</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_fields"><code class="name">var <span class="ident">model_fields</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+</dl>+<h3>Static methods</h3>+<dl>+<dt id="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema"><code class="name flex">+<span>def <span class="ident">model_json_schema</span></span>(<span>*args, **kwargs)</span>+</code></dt>+<dd>+<div class="desc"><p>Generates a JSON schema for a model class.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>by_alias</code></strong></dt>+<dd>Whether to use attribute aliases or not.</dd>+<dt><strong><code>ref_template</code></strong></dt>+<dd>The reference template.</dd>+<dt><strong><code>schema_generator</code></strong></dt>+<dd>To override the logic used to generate the JSON schema, as a subclass of+<code>GenerateJsonSchema</code> with your desired modifications</dd>+<dt><strong><code>mode</code></strong></dt>+<dd>The mode in which to generate the schema.</dd>+</dl>+<h2 id="returns">Returns</h2>+<p>The JSON schema for the given model class.</p></div>+</dd>+</dl>+</dd>+</dl>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents.lib.base" href="index.html">atomic_agents.lib.base</a></code></li>+</ul>+</li>+<li><h3><a href="#header-classes">Classes</a></h3>+<ul>+<li>+<h4><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_computed_fields" href="#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_computed_fields">model_computed_fields</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config" href="#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_config">model_config</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_fields" href="#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_fields">model_fields</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema" href="#atomic_agents.lib.base.base_io_schema.BaseIOSchema.model_json_schema">model_json_schema</a></code></li>+</ul>+</li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/lib/base/base_tool.html b/docs/lib/base/base_tool.htmlnew file mode 100644index 0000000..f5acb47--- /dev/null+++ b/docs/lib/base/base_tool.html@@ -0,0 +1,243 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.lib.base.base_tool API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.lib.base.base_tool</code></h1>+</header>+<section id="section-intro">+</section>+<section>+</section>+<section>+</section>+<section>+</section>+<section>+<h2 class="section-title" id="header-classes">Classes</h2>+<dl>+<dt id="atomic_agents.lib.base.base_tool.BaseTool"><code class="flex name class">+<span>class <span class="ident">BaseTool</span></span>+<span>(</span><span>config: <a title="atomic_agents.lib.base.base_tool.BaseToolConfig" href="#atomic_agents.lib.base.base_tool.BaseToolConfig">BaseToolConfig</a> = BaseToolConfig(title=None, description=None))</span>+</code></dt>+<dd>+<div class="desc"><p>Base class for tools within the Atomic Agents framework.</p>+<h2 id="attributes">Attributes</h2>+<dl>+<dt><strong><code>input_schema</code></strong> : <code>Type[BaseIOSchema]</code></dt>+<dd>Schema defining the input data.</dd>+<dt><strong><code>output_schema</code></strong> : <code>Type[BaseIOSchema]</code></dt>+<dd>Schema defining the output data.</dd>+<dt><strong><code>tool_name</code></strong> : <code>str</code></dt>+<dd>The name of the tool, derived from the input schema's title.</dd>+<dt><strong><code>tool_description</code></strong> : <code>str</code></dt>+<dd>Description of the tool, derived from the input schema's description or overridden by the user.</dd>+</dl>+<p>Initializes the BaseTool with an optional configuration override.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>config</code></strong> : <code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig" href="#atomic_agents.lib.base.base_tool.BaseToolConfig">BaseToolConfig</a></code>, optional</dt>+<dd>Configuration for the tool, including optional title and description overrides.</dd>+</dl></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class BaseTool:+ """+ Base class for tools within the Atomic Agents framework.++ Attributes:+ input_schema (Type[BaseIOSchema]): Schema defining the input data.+ output_schema (Type[BaseIOSchema]): Schema defining the output data.+ tool_name (str): The name of the tool, derived from the input schema's title.+ tool_description (str): Description of the tool, derived from the input schema's description or overridden by the user.+ """++ input_schema: Type[BaseIOSchema]+ output_schema: Type[BaseIOSchema]++ def __init__(self, config: BaseToolConfig = BaseToolConfig()):+ """+ Initializes the BaseTool with an optional configuration override.++ Args:+ config (BaseToolConfig, optional): Configuration for the tool, including optional title and description overrides.+ """+ self.tool_name = config.title or self.input_schema.model_json_schema()["title"]+ self.tool_description = config.description or self.input_schema.model_json_schema()["description"]++ def run(self, params: Type[BaseIOSchema]) -> BaseIOSchema:+ """+ Executes the tool with the provided parameters.++ Args:+ params (BaseIOSchema): Input parameters adhering to the input schema.++ Returns:+ BaseIOSchema: Output resulting from executing the tool, adhering to the output schema.++ Raises:+ NotImplementedError: If the method is not implemented by a subclass.+ """+ raise NotImplementedError("Subclasses should implement this method")</code></pre>+</details>+<h3>Class variables</h3>+<dl>+<dt id="atomic_agents.lib.base.base_tool.BaseTool.input_schema"><code class="name">var <span class="ident">input_schema</span> : Type[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>]</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.base.base_tool.BaseTool.output_schema"><code class="name">var <span class="ident">output_schema</span> : Type[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>]</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+</dl>+<h3>Methods</h3>+<dl>+<dt id="atomic_agents.lib.base.base_tool.BaseTool.run"><code class="name flex">+<span>def <span class="ident">run</span></span>(<span>self, params: Type[<a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>]) ‑> <a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></span>+</code></dt>+<dd>+<div class="desc"><p>Executes the tool with the provided parameters.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>params</code></strong> : <code>BaseIOSchema</code></dt>+<dd>Input parameters adhering to the input schema.</dd>+</dl>+<h2 id="returns">Returns</h2>+<dl>+<dt><code>BaseIOSchema</code></dt>+<dd>Output resulting from executing the tool, adhering to the output schema.</dd>+</dl>+<h2 id="raises">Raises</h2>+<dl>+<dt><code>NotImplementedError</code></dt>+<dd>If the method is not implemented by a subclass.</dd>+</dl></div>+</dd>+</dl>+</dd>+<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig"><code class="flex name class">+<span>class <span class="ident">BaseToolConfig</span></span>+<span>(</span><span>**data: Any)</span>+</code></dt>+<dd>+<div class="desc"><p>Configuration for a tool.</p>+<h2 id="attributes">Attributes</h2>+<dl>+<dt><strong><code>title</code></strong> : <code>Optional[str]</code></dt>+<dd>Overrides the default title of the tool.</dd>+<dt><strong><code>description</code></strong> : <code>Optional[str]</code></dt>+<dd>Overrides the default description of the tool.</dd>+</dl>+<p>Create a new model by parsing and validating input data from keyword arguments.</p>+<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be+validated to form a valid model.</p>+<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class BaseToolConfig(BaseModel):+ """+ Configuration for a tool.++ Attributes:+ title (Optional[str]): Overrides the default title of the tool.+ description (Optional[str]): Overrides the default description of the tool.+ """++ title: Optional[str] = None+ description: Optional[str] = None</code></pre>+</details>+<h3>Ancestors</h3>+<ul class="hlist">+<li>pydantic.main.BaseModel</li>+</ul>+<h3>Class variables</h3>+<dl>+<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig.description"><code class="name">var <span class="ident">description</span> : Optional[str]</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig.model_computed_fields"><code class="name">var <span class="ident">model_computed_fields</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig.model_fields"><code class="name">var <span class="ident">model_fields</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.base.base_tool.BaseToolConfig.title"><code class="name">var <span class="ident">title</span> : Optional[str]</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+</dl>+</dd>+</dl>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents.lib.base" href="index.html">atomic_agents.lib.base</a></code></li>+</ul>+</li>+<li><h3><a href="#header-classes">Classes</a></h3>+<ul>+<li>+<h4><code><a title="atomic_agents.lib.base.base_tool.BaseTool" href="#atomic_agents.lib.base.base_tool.BaseTool">BaseTool</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.lib.base.base_tool.BaseTool.input_schema" href="#atomic_agents.lib.base.base_tool.BaseTool.input_schema">input_schema</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_tool.BaseTool.output_schema" href="#atomic_agents.lib.base.base_tool.BaseTool.output_schema">output_schema</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_tool.BaseTool.run" href="#atomic_agents.lib.base.base_tool.BaseTool.run">run</a></code></li>+</ul>+</li>+<li>+<h4><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig" href="#atomic_agents.lib.base.base_tool.BaseToolConfig">BaseToolConfig</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig.description" href="#atomic_agents.lib.base.base_tool.BaseToolConfig.description">description</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig.model_computed_fields" href="#atomic_agents.lib.base.base_tool.BaseToolConfig.model_computed_fields">model_computed_fields</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig.model_config" href="#atomic_agents.lib.base.base_tool.BaseToolConfig.model_config">model_config</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig.model_fields" href="#atomic_agents.lib.base.base_tool.BaseToolConfig.model_fields">model_fields</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_tool.BaseToolConfig.title" href="#atomic_agents.lib.base.base_tool.BaseToolConfig.title">title</a></code></li>+</ul>+</li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/lib/base/index.html b/docs/lib/base/index.htmlnew file mode 100644index 0000000..139f5b8--- /dev/null+++ b/docs/lib/base/index.html@@ -0,0 +1,72 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.lib.base API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Namespace <code>atomic_agents.lib.base</code></h1>+</header>+<section id="section-intro">+</section>+<section>+<h2 class="section-title" id="header-submodules">Sub-modules</h2>+<dl>+<dt><code class="name"><a title="atomic_agents.lib.base.base_io_schema" href="base_io_schema.html">atomic_agents.lib.base.base_io_schema</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+<dt><code class="name"><a title="atomic_agents.lib.base.base_tool" href="base_tool.html">atomic_agents.lib.base.base_tool</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+</dl>+</section>+<section>+</section>+<section>+</section>+<section>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents.lib" href="../index.html">atomic_agents.lib</a></code></li>+</ul>+</li>+<li><h3><a href="#header-submodules">Sub-modules</a></h3>+<ul>+<li><code><a title="atomic_agents.lib.base.base_io_schema" href="base_io_schema.html">atomic_agents.lib.base.base_io_schema</a></code></li>+<li><code><a title="atomic_agents.lib.base.base_tool" href="base_tool.html">atomic_agents.lib.base.base_tool</a></code></li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/lib/components/agent_memory.html b/docs/lib/components/agent_memory.htmlnew file mode 100644index 0000000..1cc2b24--- /dev/null+++ b/docs/lib/components/agent_memory.html@@ -0,0 +1,444 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.lib.components.agent_memory API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.lib.components.agent_memory</code></h1>+</header>+<section id="section-intro">+</section>+<section>+</section>+<section>+</section>+<section>+</section>+<section>+<h2 class="section-title" id="header-classes">Classes</h2>+<dl>+<dt id="atomic_agents.lib.components.agent_memory.AgentMemory"><code class="flex name class">+<span>class <span class="ident">AgentMemory</span></span>+<span>(</span><span>max_messages: Optional[int] = None)</span>+</code></dt>+<dd>+<div class="desc"><p>Manages the chat history for an AI agent.</p>+<h2 id="attributes">Attributes</h2>+<dl>+<dt><strong><code>history</code></strong> : <code>List[<a title="atomic_agents.lib.components.agent_memory.Message" href="#atomic_agents.lib.components.agent_memory.Message">Message</a>]</code></dt>+<dd>A list of messages representing the chat history.</dd>+<dt><strong><code>max_messages</code></strong> : <code>Optional[int]</code></dt>+<dd>Maximum number of turns to keep in history.</dd>+<dt><strong><code>current_turn_id</code></strong> : <code>Optional[str]</code></dt>+<dd>The ID of the current turn.</dd>+</dl>+<p>Initializes the AgentMemory with an empty history and optional constraints.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>max_messages</code></strong> : <code>Optional[int]</code></dt>+<dd>Maximum number of turns to keep in history.</dd>+</dl></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class AgentMemory:+ """+ Manages the chat history for an AI agent.++ Attributes:+ history (List[Message]): A list of messages representing the chat history.+ max_messages (Optional[int]): Maximum number of turns to keep in history.+ current_turn_id (Optional[str]): The ID of the current turn.+ """++ def __init__(self, max_messages: Optional[int] = None):+ """+ Initializes the AgentMemory with an empty history and optional constraints.++ Args:+ max_messages (Optional[int]): Maximum number of turns to keep in history.+ """+ self.history: List[Message] = []+ self.max_messages = max_messages+ self.current_turn_id: Optional[str] = None++ def initialize_turn(self) -> None:+ """+ Initializes a new turn by generating a random turn ID.+ """+ self.current_turn_id = str(uuid.uuid4())++ def add_message(+ self,+ role: str,+ content: BaseIOSchema,+ ) -> None:+ """+ Adds a message to the chat history and manages overflow.++ Args:+ role (str): The role of the message sender.+ content (BaseIOSchema): The content of the message.+ """+ if self.current_turn_id is None:+ self.initialize_turn()++ message = Message(role=role, content=content, turn_id=self.current_turn_id)+ self.history.append(message)+ self._manage_overflow()++ def _manage_overflow(self) -> None:+ """+ Manages the chat history overflow based on max_messages constraint.+ """+ if self.max_messages is not None:+ while len(self.history) > self.max_messages:+ self.history.pop(0)++ def get_history(self) -> List[Dict]:+ """+ Retrieves the chat history, filtering out unnecessary fields and serializing content.++ Returns:+ List[Dict]: The list of messages in the chat history as dictionaries.+ """+ return [+ {+ "role": message.role,+ "content": json.dumps(message.content.model_dump()),+ }+ for message in self.history+ ]++ def copy(self) -> "AgentMemory":+ """+ Creates a copy of the chat memory.++ Returns:+ AgentMemory: A copy of the chat memory.+ """+ new_memory = AgentMemory(max_messages=self.max_messages)+ new_memory.load(self.dump())+ new_memory.current_turn_id = self.current_turn_id+ return new_memory++ def get_current_turn_id(self) -> Optional[str]:+ """+ Returns the current turn ID.++ Returns:+ Optional[str]: The current turn ID, or None if not set.+ """+ return self.current_turn_id++ def get_message_count(self) -> int:+ """+ Returns the number of messages in the chat history.++ Returns:+ int: The number of messages.+ """+ return len(self.history)++ def dump(self) -> str:+ """+ Serializes the entire AgentMemory instance to a JSON string.++ Returns:+ str: A JSON string representation of the AgentMemory.+ """+ serialized_history = []+ for message in self.history:+ content_class = message.content.__class__+ serialized_message = {+ "role": message.role,+ "content": {+ "class_name": f"{content_class.__module__}.{content_class.__name__}",+ "data": message.content.model_dump(),+ },+ "turn_id": message.turn_id,+ }+ serialized_history.append(serialized_message)++ memory_data = {+ "history": serialized_history,+ "max_messages": self.max_messages,+ "current_turn_id": self.current_turn_id,+ }+ return json.dumps(memory_data)++ def load(self, serialized_data: str) -> None:+ """+ Deserializes a JSON string and loads it into the AgentMemory instance.++ Args:+ serialized_data (str): A JSON string representation of the AgentMemory.++ Raises:+ ValueError: If the serialized data is invalid or cannot be deserialized.+ """+ try:+ memory_data = json.loads(serialized_data)+ self.history = []+ self.max_messages = memory_data["max_messages"]+ self.current_turn_id = memory_data["current_turn_id"]++ for message_data in memory_data["history"]:+ content_info = message_data["content"]+ content_class = self._get_class_from_string(content_info["class_name"])+ content_instance = content_class(**content_info["data"])++ message = Message(role=message_data["role"], content=content_instance, turn_id=message_data["turn_id"])+ self.history.append(message)+ except (json.JSONDecodeError, KeyError, AttributeError, TypeError) as e:+ raise ValueError(f"Invalid serialized data: {e}")++ @staticmethod+ def _get_class_from_string(class_string: str) -> Type[BaseIOSchema]:+ """+ Retrieves a class object from its string representation.++ Args:+ class_string (str): The fully qualified class name.++ Returns:+ Type[BaseIOSchema]: The class object.++ Raises:+ AttributeError: If the class cannot be found.+ """+ module_name, class_name = class_string.rsplit(".", 1)+ module = __import__(module_name, fromlist=[class_name])+ return getattr(module, class_name)</code></pre>+</details>+<h3>Methods</h3>+<dl>+<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.add_message"><code class="name flex">+<span>def <span class="ident">add_message</span></span>(<span>self, role: str, content: <a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a>) ‑> None</span>+</code></dt>+<dd>+<div class="desc"><p>Adds a message to the chat history and manages overflow.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>role</code></strong> : <code>str</code></dt>+<dd>The role of the message sender.</dd>+<dt><strong><code>content</code></strong> : <code>BaseIOSchema</code></dt>+<dd>The content of the message.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.copy"><code class="name flex">+<span>def <span class="ident">copy</span></span>(<span>self) ‑> <a title="atomic_agents.lib.components.agent_memory.AgentMemory" href="#atomic_agents.lib.components.agent_memory.AgentMemory">AgentMemory</a></span>+</code></dt>+<dd>+<div class="desc"><p>Creates a copy of the chat memory.</p>+<h2 id="returns">Returns</h2>+<dl>+<dt><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory" href="#atomic_agents.lib.components.agent_memory.AgentMemory">AgentMemory</a></code></dt>+<dd>A copy of the chat memory.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.dump"><code class="name flex">+<span>def <span class="ident">dump</span></span>(<span>self) ‑> str</span>+</code></dt>+<dd>+<div class="desc"><p>Serializes the entire AgentMemory instance to a JSON string.</p>+<h2 id="returns">Returns</h2>+<dl>+<dt><code>str</code></dt>+<dd>A JSON string representation of the AgentMemory.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.get_current_turn_id"><code class="name flex">+<span>def <span class="ident">get_current_turn_id</span></span>(<span>self) ‑> Optional[str]</span>+</code></dt>+<dd>+<div class="desc"><p>Returns the current turn ID.</p>+<h2 id="returns">Returns</h2>+<dl>+<dt><code>Optional[str]</code></dt>+<dd>The current turn ID, or None if not set.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.get_history"><code class="name flex">+<span>def <span class="ident">get_history</span></span>(<span>self) ‑> List[Dict]</span>+</code></dt>+<dd>+<div class="desc"><p>Retrieves the chat history, filtering out unnecessary fields and serializing content.</p>+<h2 id="returns">Returns</h2>+<dl>+<dt><code>List[Dict]</code></dt>+<dd>The list of messages in the chat history as dictionaries.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.get_message_count"><code class="name flex">+<span>def <span class="ident">get_message_count</span></span>(<span>self) ‑> int</span>+</code></dt>+<dd>+<div class="desc"><p>Returns the number of messages in the chat history.</p>+<h2 id="returns">Returns</h2>+<dl>+<dt><code>int</code></dt>+<dd>The number of messages.</dd>+</dl></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.initialize_turn"><code class="name flex">+<span>def <span class="ident">initialize_turn</span></span>(<span>self) ‑> None</span>+</code></dt>+<dd>+<div class="desc"><p>Initializes a new turn by generating a random turn ID.</p></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.AgentMemory.load"><code class="name flex">+<span>def <span class="ident">load</span></span>(<span>self, serialized_data: str) ‑> None</span>+</code></dt>+<dd>+<div class="desc"><p>Deserializes a JSON string and loads it into the AgentMemory instance.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>serialized_data</code></strong> : <code>str</code></dt>+<dd>A JSON string representation of the AgentMemory.</dd>+</dl>+<h2 id="raises">Raises</h2>+<dl>+<dt><code>ValueError</code></dt>+<dd>If the serialized data is invalid or cannot be deserialized.</dd>+</dl></div>+</dd>+</dl>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.Message"><code class="flex name class">+<span>class <span class="ident">Message</span></span>+<span>(</span><span>**data: Any)</span>+</code></dt>+<dd>+<div class="desc"><p>Represents a message in the chat history.</p>+<h2 id="attributes">Attributes</h2>+<dl>+<dt><strong><code>role</code></strong> : <code>str</code></dt>+<dd>The role of the message sender (e.g., 'user', 'system', 'tool').</dd>+<dt><strong><code>content</code></strong> : <code>BaseIOSchema</code></dt>+<dd>The content of the message.</dd>+<dt><strong><code>turn_id</code></strong> : <code>Optional[str]</code></dt>+<dd>Unique identifier for the turn this message belongs to.</dd>+</dl>+<p>Create a new model by parsing and validating input data from keyword arguments.</p>+<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be+validated to form a valid model.</p>+<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class Message(BaseModel):+ """+ Represents a message in the chat history.++ Attributes:+ role (str): The role of the message sender (e.g., 'user', 'system', 'tool').+ content (BaseIOSchema): The content of the message.+ turn_id (Optional[str]): Unique identifier for the turn this message belongs to.+ """++ role: str+ content: BaseIOSchema+ turn_id: Optional[str] = None</code></pre>+</details>+<h3>Ancestors</h3>+<ul class="hlist">+<li>pydantic.main.BaseModel</li>+</ul>+<h3>Class variables</h3>+<dl>+<dt id="atomic_agents.lib.components.agent_memory.Message.content"><code class="name">var <span class="ident">content</span> : <a title="atomic_agents.lib.base.base_io_schema.BaseIOSchema" href="../base/base_io_schema.html#atomic_agents.lib.base.base_io_schema.BaseIOSchema">BaseIOSchema</a></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.Message.model_computed_fields"><code class="name">var <span class="ident">model_computed_fields</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.Message.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.Message.model_fields"><code class="name">var <span class="ident">model_fields</span></code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.Message.role"><code class="name">var <span class="ident">role</span> : str</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+<dt id="atomic_agents.lib.components.agent_memory.Message.turn_id"><code class="name">var <span class="ident">turn_id</span> : Optional[str]</code></dt>+<dd>+<div class="desc"><p>The type of the None singleton.</p></div>+</dd>+</dl>+</dd>+</dl>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents.lib.components" href="index.html">atomic_agents.lib.components</a></code></li>+</ul>+</li>+<li><h3><a href="#header-classes">Classes</a></h3>+<ul>+<li>+<h4><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory" href="#atomic_agents.lib.components.agent_memory.AgentMemory">AgentMemory</a></code></h4>+<ul class="two-column">+<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.add_message" href="#atomic_agents.lib.components.agent_memory.AgentMemory.add_message">add_message</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.copy" href="#atomic_agents.lib.components.agent_memory.AgentMemory.copy">copy</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.dump" href="#atomic_agents.lib.components.agent_memory.AgentMemory.dump">dump</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.get_current_turn_id" href="#atomic_agents.lib.components.agent_memory.AgentMemory.get_current_turn_id">get_current_turn_id</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.get_history" href="#atomic_agents.lib.components.agent_memory.AgentMemory.get_history">get_history</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.get_message_count" href="#atomic_agents.lib.components.agent_memory.AgentMemory.get_message_count">get_message_count</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.initialize_turn" href="#atomic_agents.lib.components.agent_memory.AgentMemory.initialize_turn">initialize_turn</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.AgentMemory.load" href="#atomic_agents.lib.components.agent_memory.AgentMemory.load">load</a></code></li>+</ul>+</li>+<li>+<h4><code><a title="atomic_agents.lib.components.agent_memory.Message" href="#atomic_agents.lib.components.agent_memory.Message">Message</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.lib.components.agent_memory.Message.content" href="#atomic_agents.lib.components.agent_memory.Message.content">content</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.Message.model_computed_fields" href="#atomic_agents.lib.components.agent_memory.Message.model_computed_fields">model_computed_fields</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.Message.model_config" href="#atomic_agents.lib.components.agent_memory.Message.model_config">model_config</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.Message.model_fields" href="#atomic_agents.lib.components.agent_memory.Message.model_fields">model_fields</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.Message.role" href="#atomic_agents.lib.components.agent_memory.Message.role">role</a></code></li>+<li><code><a title="atomic_agents.lib.components.agent_memory.Message.turn_id" href="#atomic_agents.lib.components.agent_memory.Message.turn_id">turn_id</a></code></li>+</ul>+</li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/lib/components/index.html b/docs/lib/components/index.htmlnew file mode 100644index 0000000..b945039--- /dev/null+++ b/docs/lib/components/index.html@@ -0,0 +1,72 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.lib.components API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.lib.components</code></h1>+</header>+<section id="section-intro">+</section>+<section>+<h2 class="section-title" id="header-submodules">Sub-modules</h2>+<dl>+<dt><code class="name"><a title="atomic_agents.lib.components.agent_memory" href="agent_memory.html">atomic_agents.lib.components.agent_memory</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+<dt><code class="name"><a title="atomic_agents.lib.components.system_prompt_generator" href="system_prompt_generator.html">atomic_agents.lib.components.system_prompt_generator</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+</dl>+</section>+<section>+</section>+<section>+</section>+<section>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents.lib" href="../index.html">atomic_agents.lib</a></code></li>+</ul>+</li>+<li><h3><a href="#header-submodules">Sub-modules</a></h3>+<ul>+<li><code><a title="atomic_agents.lib.components.agent_memory" href="agent_memory.html">atomic_agents.lib.components.agent_memory</a></code></li>+<li><code><a title="atomic_agents.lib.components.system_prompt_generator" href="system_prompt_generator.html">atomic_agents.lib.components.system_prompt_generator</a></code></li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/lib/components/system_prompt_generator.html b/docs/lib/components/system_prompt_generator.htmlnew file mode 100644index 0000000..e97f1af--- /dev/null+++ b/docs/lib/components/system_prompt_generator.html@@ -0,0 +1,176 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.lib.components.system_prompt_generator API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.lib.components.system_prompt_generator</code></h1>+</header>+<section id="section-intro">+</section>+<section>+</section>+<section>+</section>+<section>+</section>+<section>+<h2 class="section-title" id="header-classes">Classes</h2>+<dl>+<dt id="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase"><code class="flex name class">+<span>class <span class="ident">SystemPromptContextProviderBase</span></span>+<span>(</span><span>title: str)</span>+</code></dt>+<dd>+<div class="desc"><p>Helper class that provides a standard way to create an ABC using+inheritance.</p></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class SystemPromptContextProviderBase(ABC):+ def __init__(self, title: str):+ self.title = title++ @abstractmethod+ def get_info(self) -> str:+ pass++ def __repr__(self) -> str:+ return self.get_info()</code></pre>+</details>+<h3>Ancestors</h3>+<ul class="hlist">+<li>abc.ABC</li>+</ul>+<h3>Methods</h3>+<dl>+<dt id="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase.get_info"><code class="name flex">+<span>def <span class="ident">get_info</span></span>(<span>self) ‑> str</span>+</code></dt>+<dd>+<div class="desc"></div>+</dd>+</dl>+</dd>+<dt id="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator"><code class="flex name class">+<span>class <span class="ident">SystemPromptGenerator</span></span>+<span>(</span><span>background: Optional[List[str]] = None, steps: Optional[List[str]] = None, output_instructions: Optional[List[str]] = None, context_providers: Optional[Dict[str, <a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase">SystemPromptContextProviderBase</a>]] = None)</span>+</code></dt>+<dd>+<div class="desc"></div>+<details class="source">+<summary>+<span>Expand source code</span>+</summary>+<pre><code class="python">class SystemPromptGenerator:+ def __init__(+ self,+ background: Optional[List[str]] = None,+ steps: Optional[List[str]] = None,+ output_instructions: Optional[List[str]] = None,+ context_providers: Optional[Dict[str, SystemPromptContextProviderBase]] = None,+ ):+ self.background = background or ["This is a conversation with a helpful and friendly AI assistant."]+ self.steps = steps or []+ self.output_instructions = output_instructions or []+ self.context_providers = context_providers or {}++ self.output_instructions.extend(+ [+ "Always respond using the proper JSON schema.",+ "Always use the available additional information and context to enhance the response.",+ ]+ )++ def generate_prompt(self) -> str:+ sections = [+ ("IDENTITY and PURPOSE", self.background),+ ("INTERNAL ASSISTANT STEPS", self.steps),+ ("OUTPUT INSTRUCTIONS", self.output_instructions),+ ]++ prompt_parts = []++ for title, content in sections:+ if content:+ prompt_parts.append(f"# {title}")+ prompt_parts.extend(f"- {item}" for item in content)+ prompt_parts.append("")++ if self.context_providers:+ prompt_parts.append("# EXTRA INFORMATION AND CONTEXT")+ for provider in self.context_providers.values():+ info = provider.get_info()+ if info:+ prompt_parts.append(f"## {provider.title}")+ prompt_parts.append(info)+ prompt_parts.append("")++ return "\n".join(prompt_parts).strip()</code></pre>+</details>+<h3>Methods</h3>+<dl>+<dt id="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator.generate_prompt"><code class="name flex">+<span>def <span class="ident">generate_prompt</span></span>(<span>self) ‑> str</span>+</code></dt>+<dd>+<div class="desc"></div>+</dd>+</dl>+</dd>+</dl>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents.lib.components" href="index.html">atomic_agents.lib.components</a></code></li>+</ul>+</li>+<li><h3><a href="#header-classes">Classes</a></h3>+<ul>+<li>+<h4><code><a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase">SystemPromptContextProviderBase</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase.get_info" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptContextProviderBase.get_info">get_info</a></code></li>+</ul>+</li>+<li>+<h4><code><a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator">SystemPromptGenerator</a></code></h4>+<ul class="">+<li><code><a title="atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator.generate_prompt" href="#atomic_agents.lib.components.system_prompt_generator.SystemPromptGenerator.generate_prompt">generate_prompt</a></code></li>+</ul>+</li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/lib/index.html b/docs/lib/index.htmlnew file mode 100644index 0000000..37b7212--- /dev/null+++ b/docs/lib/index.html@@ -0,0 +1,77 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.lib API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.lib</code></h1>+</header>+<section id="section-intro">+</section>+<section>+<h2 class="section-title" id="header-submodules">Sub-modules</h2>+<dl>+<dt><code class="name"><a title="atomic_agents.lib.base" href="base/index.html">atomic_agents.lib.base</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+<dt><code class="name"><a title="atomic_agents.lib.components" href="components/index.html">atomic_agents.lib.components</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+<dt><code class="name"><a title="atomic_agents.lib.utils" href="utils/index.html">atomic_agents.lib.utils</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+</dl>+</section>+<section>+</section>+<section>+</section>+<section>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents" href="../index.html">atomic_agents</a></code></li>+</ul>+</li>+<li><h3><a href="#header-submodules">Sub-modules</a></h3>+<ul>+<li><code><a title="atomic_agents.lib.base" href="base/index.html">atomic_agents.lib.base</a></code></li>+<li><code><a title="atomic_agents.lib.components" href="components/index.html">atomic_agents.lib.components</a></code></li>+<li><code><a title="atomic_agents.lib.utils" href="utils/index.html">atomic_agents.lib.utils</a></code></li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/lib/utils/format_tool_message.html b/docs/lib/utils/format_tool_message.htmlnew file mode 100644index 0000000..e2b9c6e--- /dev/null+++ b/docs/lib/utils/format_tool_message.html@@ -0,0 +1,81 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.lib.utils.format_tool_message API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.lib.utils.format_tool_message</code></h1>+</header>+<section id="section-intro">+</section>+<section>+</section>+<section>+</section>+<section>+<h2 class="section-title" id="header-functions">Functions</h2>+<dl>+<dt id="atomic_agents.lib.utils.format_tool_message.format_tool_message"><code class="name flex">+<span>def <span class="ident">format_tool_message</span></span>(<span>tool_call: Type[pydantic.main.BaseModel], tool_id: Optional[str] = None) ‑> Dict</span>+</code></dt>+<dd>+<div class="desc"><p>Formats a message for a tool call.</p>+<h2 id="args">Args</h2>+<dl>+<dt><strong><code>tool_call</code></strong> : <code>Type[BaseModel]</code></dt>+<dd>The Pydantic model instance representing the tool call.</dd>+<dt><strong><code>tool_id</code></strong> : <code>str</code>, optional</dt>+<dd>The unique identifier for the tool call. If not provided, a random UUID will be generated.</dd>+</dl>+<h2 id="returns">Returns</h2>+<dl>+<dt><code>Dict</code></dt>+<dd>A formatted message dictionary for the tool call.</dd>+</dl></div>+</dd>+</dl>+</section>+<section>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents.lib.utils" href="index.html">atomic_agents.lib.utils</a></code></li>+</ul>+</li>+<li><h3><a href="#header-functions">Functions</a></h3>+<ul class="">+<li><code><a title="atomic_agents.lib.utils.format_tool_message.format_tool_message" href="#atomic_agents.lib.utils.format_tool_message.format_tool_message">format_tool_message</a></code></li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/docs/lib/utils/index.html b/docs/lib/utils/index.htmlnew file mode 100644index 0000000..15c451e--- /dev/null+++ b/docs/lib/utils/index.html@@ -0,0 +1,67 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">+<meta name="generator" content="pdoc3 0.11.1">+<title>atomic_agents.lib.utils API documentation</title>+<meta name="description" content="">+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>+<script>window.addEventListener('DOMContentLoaded', () => {+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});+hljs.highlightAll();+})</script>+</head>+<body>+<main>+<article id="content">+<header>+<h1 class="title">Module <code>atomic_agents.lib.utils</code></h1>+</header>+<section id="section-intro">+</section>+<section>+<h2 class="section-title" id="header-submodules">Sub-modules</h2>+<dl>+<dt><code class="name"><a title="atomic_agents.lib.utils.format_tool_message" href="format_tool_message.html">atomic_agents.lib.utils.format_tool_message</a></code></dt>+<dd>+<div class="desc"></div>+</dd>+</dl>+</section>+<section>+</section>+<section>+</section>+<section>+</section>+</article>+<nav id="sidebar">+<div class="toc">+<ul></ul>+</div>+<ul id="index">+<li><h3>Super-module</h3>+<ul>+<li><code><a title="atomic_agents.lib" href="../index.html">atomic_agents.lib</a></code></li>+</ul>+</li>+<li><h3><a href="#header-submodules">Sub-modules</a></h3>+<ul>+<li><code><a title="atomic_agents.lib.utils.format_tool_message" href="format_tool_message.html">atomic_agents.lib.utils.format_tool_message</a></code></li>+</ul>+</li>+</ul>+</nav>+</main>+<footer id="footer">+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>+</footer>+</body>+</html>diff --git a/poetry.lock b/poetry.lockindex 0152fa8..de8cb23 100644--- a/poetry.lock+++ b/poetry.lock@@ -701,6 +701,40 @@ dev = ["black", "flake8", "isort", "pre-commit", "pyproject-flake8"]doc = ["myst-parser", "sphinx", "sphinx-book-theme"]test = ["coverage", "pytest", "pytest-cov"]+[[package]]+name = "mako"+version = "1.3.5"+description = "A super-fast templating language that borrows the best ideas from the existing templating languages."+optional = false+python-versions = ">=3.8"+files = [+ {file = "Mako-1.3.5-py3-none-any.whl", hash = "sha256:260f1dbc3a519453a9c856dedfe4beb4e50bd5a26d96386cb6c80856556bb91a"},+ {file = "Mako-1.3.5.tar.gz", hash = "sha256:48dbc20568c1d276a2698b36d968fa76161bf127194907ea6fc594fa81f943bc"},+]++[package.dependencies]+MarkupSafe = ">=0.9.2"++[package.extras]+babel = ["Babel"]+lingua = ["lingua"]+testing = ["pytest"]++[[package]]+name = "markdown"+version = "3.7"+description = "Python implementation of John Gruber's Markdown."+optional = false+python-versions = ">=3.8"+files = [+ {file = "Markdown-3.7-py3-none-any.whl", hash = "sha256:7eb6df5690b81a1d7942992c97fad2938e956e79df20cbc6186e9c3a77b1c803"},+ {file = "markdown-3.7.tar.gz", hash = "sha256:2ae2471477cfd02dbbf038d5d9bc226d40def84b4fe2986e49b59b6b472bbed2"},+]++[package.extras]+docs = ["mdx-gh-links (>=0.2)", "mkdocs (>=1.5)", "mkdocs-gen-files", "mkdocs-literate-nav", "mkdocs-nature (>=0.6)", "mkdocs-section-index", "mkdocstrings[python]"]+testing = ["coverage", "pyyaml"]+[[package]]name = "markdown-it-py"version = "3.0.0"@@ -727,6 +761,76 @@ profiling = ["gprof2dot"]rtd = ["jupyter_sphinx", "mdit-py-plugins", "myst-parser", "pyyaml", "sphinx", "sphinx-copybutton", "sphinx-design", "sphinx_book_theme"]testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"]+[[package]]+name = "markupsafe"+version = "3.0.1"+description = "Safely add untrusted strings to HTML/XML markup."+optional = false+python-versions = ">=3.9"+files = [+ {file = "MarkupSafe-3.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:db842712984e91707437461930e6011e60b39136c7331e971952bb30465bc1a1"},+ {file = "MarkupSafe-3.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:3ffb4a8e7d46ed96ae48805746755fadd0909fea2306f93d5d8233ba23dda12a"},+ {file = "MarkupSafe-3.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:67c519635a4f64e495c50e3107d9b4075aec33634272b5db1cde839e07367589"},+ {file = "MarkupSafe-3.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:48488d999ed50ba8d38c581d67e496f955821dc183883550a6fbc7f1aefdc170"},+ {file = "MarkupSafe-3.0.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f31ae06f1328595d762c9a2bf29dafd8621c7d3adc130cbb46278079758779ca"},+ {file = "MarkupSafe-3.0.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:80fcbf3add8790caddfab6764bde258b5d09aefbe9169c183f88a7410f0f6dea"},+ {file = "MarkupSafe-3.0.1-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:3341c043c37d78cc5ae6e3e305e988532b072329639007fd408a476642a89fd6"},+ {file = "MarkupSafe-3.0.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:cb53e2a99df28eee3b5f4fea166020d3ef9116fdc5764bc5117486e6d1211b25"},+ {file = "MarkupSafe-3.0.1-cp310-cp310-win32.whl", hash = "sha256:db15ce28e1e127a0013dfb8ac243a8e392db8c61eae113337536edb28bdc1f97"},+ {file = "MarkupSafe-3.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:4ffaaac913c3f7345579db4f33b0020db693f302ca5137f106060316761beea9"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:26627785a54a947f6d7336ce5963569b5d75614619e75193bdb4e06e21d447ad"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:b954093679d5750495725ea6f88409946d69cfb25ea7b4c846eef5044194f583"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:973a371a55ce9ed333a3a0f8e0bcfae9e0d637711534bcb11e130af2ab9334e7"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:244dbe463d5fb6d7ce161301a03a6fe744dac9072328ba9fc82289238582697b"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d98e66a24497637dd31ccab090b34392dddb1f2f811c4b4cd80c230205c074a3"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:ad91738f14eb8da0ff82f2acd0098b6257621410dcbd4df20aaa5b4233d75a50"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:7044312a928a66a4c2a22644147bc61a199c1709712069a344a3fb5cfcf16915"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:a4792d3b3a6dfafefdf8e937f14906a51bd27025a36f4b188728a73382231d91"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-win32.whl", hash = "sha256:fa7d686ed9883f3d664d39d5a8e74d3c5f63e603c2e3ff0abcba23eac6542635"},+ {file = "MarkupSafe-3.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:9ba25a71ebf05b9bb0e2ae99f8bc08a07ee8e98c612175087112656ca0f5c8bf"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:8ae369e84466aa70f3154ee23c1451fda10a8ee1b63923ce76667e3077f2b0c4"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40f1e10d51c92859765522cbd79c5c8989f40f0419614bcdc5015e7b6bf97fc5"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5a4cb365cb49b750bdb60b846b0c0bc49ed62e59a76635095a179d440540c346"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ee3941769bd2522fe39222206f6dd97ae83c442a94c90f2b7a25d847d40f4729"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:62fada2c942702ef8952754abfc1a9f7658a4d5460fabe95ac7ec2cbe0d02abc"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:4c2d64fdba74ad16138300815cfdc6ab2f4647e23ced81f59e940d7d4a1469d9"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:fb532dd9900381d2e8f48172ddc5a59db4c445a11b9fab40b3b786da40d3b56b"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:0f84af7e813784feb4d5e4ff7db633aba6c8ca64a833f61d8e4eade234ef0c38"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-win32.whl", hash = "sha256:cbf445eb5628981a80f54087f9acdbf84f9b7d862756110d172993b9a5ae81aa"},+ {file = "MarkupSafe-3.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:a10860e00ded1dd0a65b83e717af28845bb7bd16d8ace40fe5531491de76b79f"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:e81c52638315ff4ac1b533d427f50bc0afc746deb949210bc85f05d4f15fd772"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:312387403cd40699ab91d50735ea7a507b788091c416dd007eac54434aee51da"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2ae99f31f47d849758a687102afdd05bd3d3ff7dbab0a8f1587981b58a76152a"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c97ff7fedf56d86bae92fa0a646ce1a0ec7509a7578e1ed238731ba13aabcd1c"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a7420ceda262dbb4b8d839a4ec63d61c261e4e77677ed7c66c99f4e7cb5030dd"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:45d42d132cff577c92bfba536aefcfea7e26efb975bd455db4e6602f5c9f45e7"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:4c8817557d0de9349109acb38b9dd570b03cc5014e8aabf1cbddc6e81005becd"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:6a54c43d3ec4cf2a39f4387ad044221c66a376e58c0d0e971d47c475ba79c6b5"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-win32.whl", hash = "sha256:c91b394f7601438ff79a4b93d16be92f216adb57d813a78be4446fe0f6bc2d8c"},+ {file = "MarkupSafe-3.0.1-cp313-cp313-win_amd64.whl", hash = "sha256:fe32482b37b4b00c7a52a07211b479653b7fe4f22b2e481b9a9b099d8a430f2f"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:17b2aea42a7280db02ac644db1d634ad47dcc96faf38ab304fe26ba2680d359a"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:852dc840f6d7c985603e60b5deaae1d89c56cb038b577f6b5b8c808c97580f1d"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0778de17cff1acaeccc3ff30cd99a3fd5c50fc58ad3d6c0e0c4c58092b859396"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:800100d45176652ded796134277ecb13640c1a537cad3b8b53da45aa96330453"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d06b24c686a34c86c8c1fba923181eae6b10565e4d80bdd7bc1c8e2f11247aa4"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:33d1c36b90e570ba7785dacd1faaf091203d9942bc036118fab8110a401eb1a8"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:beeebf760a9c1f4c07ef6a53465e8cfa776ea6a2021eda0d0417ec41043fe984"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:bbde71a705f8e9e4c3e9e33db69341d040c827c7afa6789b14c6e16776074f5a"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-win32.whl", hash = "sha256:82b5dba6eb1bcc29cc305a18a3c5365d2af06ee71b123216416f7e20d2a84e5b"},+ {file = "MarkupSafe-3.0.1-cp313-cp313t-win_amd64.whl", hash = "sha256:730d86af59e0e43ce277bb83970530dd223bf7f2a838e086b50affa6ec5f9295"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:4935dd7883f1d50e2ffecca0aa33dc1946a94c8f3fdafb8df5c330e48f71b132"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:e9393357f19954248b00bed7c56f29a25c930593a77630c719653d51e7669c2a"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:40621d60d0e58aa573b68ac5e2d6b20d44392878e0bfc159012a5787c4e35bc8"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f94190df587738280d544971500b9cafc9b950d32efcb1fba9ac10d84e6aa4e6"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b6a387d61fe41cdf7ea95b38e9af11cfb1a63499af2759444b99185c4ab33f5b"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:8ad4ad1429cd4f315f32ef263c1342166695fad76c100c5d979c45d5570ed58b"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:e24bfe89c6ac4c31792793ad9f861b8f6dc4546ac6dc8f1c9083c7c4f2b335cd"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:2a4b34a8d14649315c4bc26bbfa352663eb51d146e35eef231dd739d54a5430a"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-win32.whl", hash = "sha256:242d6860f1fd9191aef5fae22b51c5c19767f93fb9ead4d21924e0bcb17619d8"},+ {file = "MarkupSafe-3.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:93e8248d650e7e9d49e8251f883eed60ecbc0e8ffd6349e18550925e31bd029b"},+ {file = "markupsafe-3.0.1.tar.gz", hash = "sha256:3e683ee4f5d0fa2dde4db77ed8dd8a876686e3fc417655c2ece9a90576905344"},+]+[[package]]name = "mccabe"version = "0.7.0"@@ -926,6 +1030,20 @@ files = [{file = "pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712"},]+[[package]]+name = "pdoc3"+version = "0.11.1"+description = "Auto-generate API documentation for Python projects."+optional = false+python-versions = ">=3.9"+files = [+ {file = "pdoc3-0.11.1.tar.gz", hash = "sha256:20bf2aad8110892573fd350b1bf95f6612b53b55e29b0fc143b5f2b5bcbabfb6"},+]++[package.dependencies]+mako = "*"+markdown = ">=3.0"+[[package]]name = "platformdirs"version = "4.3.6"@@ -1606,4 +1724,4 @@ propcache = ">=0.2.0"[metadata]lock-version = "2.0"python-versions = ">=3.11,<4.0"-content-hash = "aec645b798c7f080897ab95d005defef062f7a78889dbc208c1f1cf849d05966"+content-hash = "5a5bab24c495090ab5b1c2fa746acf97ab09f54cd0b85494d05736ecfc21a992"diff --git a/pyproject.toml b/pyproject.tomlindex 9d1eb68..cf108af 100644--- a/pyproject.toml+++ b/pyproject.toml@@ -24,6 +24,7 @@ pyfiglet = ">=1.0.2,<2.0.0"textual = ">=0.82.0,<1.0.0"pyyaml = ">=6.0.2,<7.0.0"python-dotenv = "^1.0.1"+pdoc3 = "^0.11.1"[tool.poetry.group.dev.dependencies]black = ">=24.8.0,<25.0.0"