Metadata-Version: 2.4
Name: autourgos-starter
Version: 1.0.0
Summary: Beginner-friendly starter bundle for the Autourgos framework — one install, one function, a working agent
Author-email: Jitin Kumar Sengar <devxjitin@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Jitin Kumar Sengar
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/devxjitin/autourgos-starter
Project-URL: Repository, https://github.com/devxjitin/autourgos-starter
Project-URL: Issues, https://github.com/devxjitin/autourgos-starter/issues
Keywords: autourgos,starter,quickstart,react,agent,openai,llm,ai,tool-calling,autonomous
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: autourgos-react-agent>=1.6.0
Requires-Dist: autourgos-openaichat>=1.0.2
Requires-Dist: autourgos-buffer-memory>=2.0.1
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# autourgos-starter

The fastest way to get a working [Autourgos](https://github.com/devxjitin) agent running.

Newcomers to the framework normally have to find and install a core agent
package, an LLM backend, and a memory backend separately, each with its
own README, before they get anything working. `autourgos-starter`
bundles the recommended default stack as real pip dependencies (nothing
vendored or copied) and gives you one function that wires them together.

---

## Install

```bash
pip install autourgos-starter
```

Set your API key:

```bash
export OPENAI_API_KEY="sk-..."
```

---

## Quick Start

This whole block is copy-pasteable — no placeholder variables to fill in.

```python
from autourgos_starter import create_starter_agent, tool

@tool
def add(a: float, b: float) -> float:
    """Add two numbers together."""
    return a + b

agent = create_starter_agent()
agent.add_tools(add)

result = agent.invoke("What is 12 + 30?")
print(result)
```

That's it — two lines to build the agent (`create_starter_agent()` and
`agent.add_tools(add)`), one line to run it (`agent.invoke(...)`).

---

## What's actually happening

`autourgos-starter` is just a convenience wrapper. `create_starter_agent()` does this:

```python
from autourgos_react_agent import ReactAgent
from autourgos_openaichat import OpenAIChatModel
from autourgos_buffer_memory import ConversationBufferMemory

llm = OpenAIChatModel(model="gpt-4o-mini", api_key=None, system_instruction=None)
memory = ConversationBufferMemory()
agent = ReactAgent(llm=llm, memory=memory)
```

Three real, independently-installable packages, each maintained on its own:

- [`autourgos-react-agent`](https://github.com/devxjitin/autourgos-react-agent) — the ReAct agent loop itself (`ReactAgent`, `tool`).
- [`autourgos-openaichat`](https://github.com/devxjitin/autourgos-openaichat) — the LLM backend (`OpenAIChatModel`), talks to the OpenAI Chat Completions API or any OpenAI-compatible endpoint (set `base_url` to point at a local server such as Ollama, LM Studio, or vLLM).
- [`autourgos-buffer-memory`](https://github.com/devxjitin/autourgos-buffer-memory) — the memory backend (`ConversationBufferMemory`), an unbounded in-memory conversation buffer.

This package is optional scaffolding, not a requirement to use the
Autourgos framework. If you want a different memory backend (e.g.
`autourgos-summary-memory`, `autourgos-token-memory`) or a different LLM
backend (e.g. `autourgos-responses`), skip `autourgos-starter` and wire
`ReactAgent` up to those packages directly — that's exactly what this
package does under the hood, just with sensible defaults picked for you.

---

## `create_starter_agent()` reference

```python
def create_starter_agent(
    api_key: str | None = None,
    model: str = "gpt-4o-mini",
    system_prompt: str | None = None,
    **kwargs,
) -> ReactAgent
```

| Argument | Default | Meaning |
|---|---|---|
| `api_key` | `None` | OpenAI API key. Falls back to the `OPENAI_API_KEY` env var if not given. |
| `model` | `"gpt-4o-mini"` | OpenAI model name, e.g. `"gpt-4o"`, `"gpt-4o-mini"`. |
| `system_prompt` | `None` | Optional system instruction, forwarded to `OpenAIChatModel`. |
| `**kwargs` | — | Forwarded to `ReactAgent` — e.g. `verbose=True`, `max_iterations=10`, `memory=...` to override the default `ConversationBufferMemory`, `middleware=[...]`. |

Returns a `ReactAgent` instance. Call `agent.add_tools(...)` before
`agent.invoke(...)` / `agent.ainvoke(...)`.

---

## Also re-exported

So you don't need to know which sub-package a class lives in:

```python
from autourgos_starter import ReactAgent, tool, OpenAIChatModel, ConversationBufferMemory
```

---

## License

MIT
