grasp_agents 0.1.7__tar.gz → 0.1.10__tar.gz

grasp_agents-0.1.10/LICENSE.md

@@ -0,0 +1,13 @@
+Grasp Agents itself is [MIT](https://mit-license.org/)-licensed.
+
+Package production dependencies are licensed under the following terms:
+
+| Name      | Version | License                                           | URL                                     |
+| --------- | ------- | ------------------------------------------------- | --------------------------------------- |
+| PyYAML    | 6.0.2   | MIT License                                       | https://pyyaml.org/                     |
+| dotenv    | 0.9.9   | BSD-3-Clause license                              | https://github.com/pedroburon/dotenv    |
+| httpx     | 0.28.1  | BSD License                                       | https://github.com/encode/httpx         |
+| openai    | 1.77.0  | Apache Software License                           | https://github.com/openai/openai-python |
+| tenacity  | 9.1.2   | Apache Software License                           | https://github.com/jd/tenacity          |
+| termcolor | 2.5.0   | MIT License                                       | https://github.com/termcolor/termcolor  |
+| tqdm      | 4.67.1  | MIT License; Mozilla Public License 2.0 (MPL 2.0) | https://tqdm.github.io                  |

grasp_agents-0.1.10/PKG-INFO

@@ -0,0 +1,318 @@
+Metadata-Version: 2.4
+Name: grasp_agents
+Version: 0.1.10
+Summary: Grasp Agents Library
+License-File: LICENSE
+License-File: LICENSE.md
+Requires-Python: <3.12,>=3.11.4
+Requires-Dist: dotenv>=0.9.9
+Requires-Dist: httpx<1,>=0.27.0
+Requires-Dist: openai<2,>=1.68.2
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: tenacity>=9.1.2
+Requires-Dist: termcolor<3,>=2.4.0
+Requires-Dist: tqdm<5,>=4.66.2
+Description-Content-Type: text/markdown
+
+# Grasp Agents
+
+<br/>
+<img src="./.assets/grasp.png" alt="Grasp Agents" width="320" />
+<br/>
+<br/>
+
+[![PyPI version](https://badge.fury.io/py/grasp_agents.svg)](https://badge.fury.io/py/grasp_agents)
+[![Python Versions](https://img.shields.io/pypi/pyversions/grasp_agents?style=flat-square)](https://pypi.org/project/grasp_agents/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-yellow?style=flat-square)](https://mit-license.org/)
+
+## Overview
+
+**Grasp Agents** is a modular Python framework for building agentic AI pipelines and applications. It provides reusable agent classes, message handling, LLM integration, memory, and orchestration utilities. The framework is designed for flexibility, composability, and clarity, enabling rapid prototyping and robust development of multi-agent systems.
+
+## Features
+
+- Modular agent base classes
+- Message and memory management
+- LLM and tool orchestration
+- Logging and usage tracking
+- Extensible architecture
+
+## Project Structure
+
+- `src/grasp_agents/` — Core framework modules
+  - `base_agent.py`, `llm_agent.py`, `comm_agent.py`: Agent classes
+  - `agent_message.py`, `agent_message_pool.py`: Messaging
+  - `memory.py`: Memory management
+  - `cloud_llm.py`, `llm.py`: LLM integration
+  - `tool_orchestrator.py`: Tool orchestration
+  - `usage_tracker.py`, `grasp_logging.py`: Usage and logging
+  - `data_retrieval/`, `openai/`, `typing/`, `workflow/`: Extensions and utilities
+- `configs/` — Configuration files
+- `data/` — Logs and datasets
+
+## Quickstart & Installation Variants
+
+### Option 1: UV Package Manager Project
+
+> **Note:** You can check this sample project code in the [src/grasp_agents/examples/demo/uv](src/grasp_agents/examples/demo/uv) folder. Feel free to copy and paste the code from there to a separate project.
+
+#### 1. Prerequisites
+
+Install the [UV Package Manager](https://github.com/astral-sh/uv):
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+#### 2. Create Project & Install Dependencies
+
+```bash
+mkdir my-test-uv-app
+cd my-test-uv-app
+uv init .
+```
+
+Create and activate a virtual environment:
+
+```bash
+uv venv
+source .venv/bin/activate
+```
+
+Add and sync dependencies:
+
+```bash
+uv add grasp_agents
+uv sync
+```
+
+#### 3. Example Usage
+
+Create a file, e.g., `hello.py`:
+
+Ensure you have a `.env` file with your OpenAI and Google AI Studio API keys set
+
+```
+OPENAI_API_KEY=your_openai_api_key
+GOOGLE_AI_STUDIO_API_KEY=your_google_ai_studio_api_key
+```
+
+```python
+import asyncio
+from typing import Any
+
+from grasp_agents.llm_agent import LLMAgent
+from grasp_agents.openai.openai_llm import (
+    OpenAILLM,
+    OpenAILLMSettings,
+)
+from grasp_agents.typing.io import (
+    AgentPayload,
+)
+from grasp_agents.run_context import RunContextWrapper
+
+from dotenv import load_dotenv
+
+load_dotenv()
+
+class Response(AgentPayload):
+    response: str
+
+
+chatbot = LLMAgent[Any, Response, None](
+    agent_id="chatbot",
+    llm=OpenAILLM(
+        model_name="gpt-4o",
+        llm_settings=OpenAILLMSettings(),
+    ),
+    sys_prompt=None,
+    out_schema=Response,
+)
+
+
+@chatbot.parse_output_handler
+def output_handler(conversation, ctx, **kwargs) -> Response:
+    return Response(response=conversation[-1].content)
+
+
+async def main():
+    ctx = RunContextWrapper(print_messages=True)
+    out = await chatbot.run("Hello, agent!", ctx=ctx)
+    print(out.payloads[0].response)
+
+
+asyncio.run(main())
+```
+
+Run your script:
+
+```bash
+uv run hello.py
+```
+
+---
+
+### Option 2: PIP-only (requirements.txt-based) Project
+
+> **Note:** You can check this sample project code in the [src/grasp_agents/examples/demo/pip](src/grasp_agents/examples/demo/pip) folder. Feel free to copy and paste the code from there to a separate project.
+
+#### 1. Create Project Folder
+
+```bash
+mkdir my-test-pip-app
+cd my-test-pip-app
+```
+
+#### 2. Install Python 3.11.9 (Recommended)
+
+If using [pyenv](https://github.com/pyenv/pyenv):
+
+```bash
+brew install pyenv
+pyenv install 3.11.9
+pyenv local 3.11.9
+```
+
+Open a new terminal after setting the Python version.
+
+#### 3. Create & Activate Virtual Environment
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+#### 4. Install Grasp Agents SDK
+
+If you have a `requirements.txt` file:
+
+```bash
+pip install -r requirements.txt
+```
+
+Or install directly:
+
+```bash
+pip install grasp-agents
+```
+
+#### 5. Example Usage
+
+Create a file, e.g., `hello.py`, and use the same code as above.
+
+#### 6. Run the App
+
+```bash
+python hello.py
+```
+
+---
+
+### Option 3: Poetry-based Project
+
+> **Note:** You can check this sample project code in the [src/grasp_agents/examples/demo/poetry](src/grasp_agents/examples/demo/poetry) folder. Feel free to copy and paste the code from there to a separate project.
+
+#### 1. Create Project Folder
+
+```bash
+mkdir my-test-poetry-app
+cd my-test-poetry-app
+```
+
+#### 2. Install Python 3.11.9 via pyenv
+
+```bash
+brew install pyenv
+pyenv install 3.11.9
+pyenv local 3.11.9
+```
+
+#### 3. Install Poetry Package Manager
+
+If you don't have Poetry, install it:
+
+```bash
+curl -sSL https://install.python-poetry.org | python3 -
+```
+
+Open a new terminal after installing Poetry.
+
+#### 4. Create and Activate a Virtual Environment
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+#### 5. Make Poetry Use the Virtual Environment's Python
+
+```bash
+poetry env use $(which python)
+```
+
+#### 6. Install the Grasp Agents SDK
+
+```bash
+poetry install
+```
+
+#### 7. Example Usage
+
+Create a file, e.g., `hello.py`, and use the same code as above.
+
+#### 8. Environment Variables
+
+Ensure you have a `.env` file with your OpenAI API key set:
+
+```
+OPENAI_API_KEY=your_openai_api_key
+```
+
+#### 9. Run the App
+
+```bash
+poetry run python hello.py
+```
+
+## Development
+
+To develop and test the library locally, follow these steps:
+
+### 1. Install UV Package Manager
+
+Make sure [UV](https://github.com/astral-sh/uv) is installed on your system:
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+### 2. Install Dependencies
+
+Create a new virtual environment and install dependencies:
+
+```bash
+uv venv
+source .venv/bin/activate
+uv sync
+```
+
+### 3. Test Example for VS Code
+
+- Install the [Jupyter Notebook extension](https://marketplace.visualstudio.com/items/?itemName=ms-toolsai.jupyter).
+
+- Ensure you have a `.env` file with your OpenAI and Google AI Studio API keys set (see [.env.example](.env.example)).
+
+```
+OPENAI_API_KEY=your_openai_api_key
+GOOGLE_AI_STUDIO_API_KEY=your_google_ai_studio_api_key
+```
+
+- Open [src/grasp_agents/examples/notebooks/agents_demo.ipynb](src/grasp_agents/examples/notebooks/agents_demo.ipynb).
+
+You're now ready to run and experiment with the example notebook.
+
+### 4. Recommended VS Code Extensions
+
+- [Ruff](https://marketplace.visualstudio.com/items/?itemName=charliermarsh.ruff) -- for formatting and code analysis
+- [Pylint](https://marketplace.visualstudio.com/items/?itemName=ms-python.pylint) -- for linting
+- [Pylance](https://marketplace.visualstudio.com/items/?itemName=ms-python.vscode-pylance) -- for type checking

grasp_agents-0.1.10/README.md

@@ -0,0 +1,302 @@
+# Grasp Agents
+
+<br/>
+<img src="./.assets/grasp.png" alt="Grasp Agents" width="320" />
+<br/>
+<br/>
+
+[![PyPI version](https://badge.fury.io/py/grasp_agents.svg)](https://badge.fury.io/py/grasp_agents)
+[![Python Versions](https://img.shields.io/pypi/pyversions/grasp_agents?style=flat-square)](https://pypi.org/project/grasp_agents/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-yellow?style=flat-square)](https://mit-license.org/)
+
+## Overview
+
+**Grasp Agents** is a modular Python framework for building agentic AI pipelines and applications. It provides reusable agent classes, message handling, LLM integration, memory, and orchestration utilities. The framework is designed for flexibility, composability, and clarity, enabling rapid prototyping and robust development of multi-agent systems.
+
+## Features
+
+- Modular agent base classes
+- Message and memory management
+- LLM and tool orchestration
+- Logging and usage tracking
+- Extensible architecture
+
+## Project Structure
+
+- `src/grasp_agents/` — Core framework modules
+  - `base_agent.py`, `llm_agent.py`, `comm_agent.py`: Agent classes
+  - `agent_message.py`, `agent_message_pool.py`: Messaging
+  - `memory.py`: Memory management
+  - `cloud_llm.py`, `llm.py`: LLM integration
+  - `tool_orchestrator.py`: Tool orchestration
+  - `usage_tracker.py`, `grasp_logging.py`: Usage and logging
+  - `data_retrieval/`, `openai/`, `typing/`, `workflow/`: Extensions and utilities
+- `configs/` — Configuration files
+- `data/` — Logs and datasets
+
+## Quickstart & Installation Variants
+
+### Option 1: UV Package Manager Project
+
+> **Note:** You can check this sample project code in the [src/grasp_agents/examples/demo/uv](src/grasp_agents/examples/demo/uv) folder. Feel free to copy and paste the code from there to a separate project.
+
+#### 1. Prerequisites
+
+Install the [UV Package Manager](https://github.com/astral-sh/uv):
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+#### 2. Create Project & Install Dependencies
+
+```bash
+mkdir my-test-uv-app
+cd my-test-uv-app
+uv init .
+```
+
+Create and activate a virtual environment:
+
+```bash
+uv venv
+source .venv/bin/activate
+```
+
+Add and sync dependencies:
+
+```bash
+uv add grasp_agents
+uv sync
+```
+
+#### 3. Example Usage
+
+Create a file, e.g., `hello.py`:
+
+Ensure you have a `.env` file with your OpenAI and Google AI Studio API keys set
+
+```
+OPENAI_API_KEY=your_openai_api_key
+GOOGLE_AI_STUDIO_API_KEY=your_google_ai_studio_api_key
+```
+
+```python
+import asyncio
+from typing import Any
+
+from grasp_agents.llm_agent import LLMAgent
+from grasp_agents.openai.openai_llm import (
+    OpenAILLM,
+    OpenAILLMSettings,
+)
+from grasp_agents.typing.io import (
+    AgentPayload,
+)
+from grasp_agents.run_context import RunContextWrapper
+
+from dotenv import load_dotenv
+
+load_dotenv()
+
+class Response(AgentPayload):
+    response: str
+
+
+chatbot = LLMAgent[Any, Response, None](
+    agent_id="chatbot",
+    llm=OpenAILLM(
+        model_name="gpt-4o",
+        llm_settings=OpenAILLMSettings(),
+    ),
+    sys_prompt=None,
+    out_schema=Response,
+)
+
+
+@chatbot.parse_output_handler
+def output_handler(conversation, ctx, **kwargs) -> Response:
+    return Response(response=conversation[-1].content)
+
+
+async def main():
+    ctx = RunContextWrapper(print_messages=True)
+    out = await chatbot.run("Hello, agent!", ctx=ctx)
+    print(out.payloads[0].response)
+
+
+asyncio.run(main())
+```
+
+Run your script:
+
+```bash
+uv run hello.py
+```
+
+---
+
+### Option 2: PIP-only (requirements.txt-based) Project
+
+> **Note:** You can check this sample project code in the [src/grasp_agents/examples/demo/pip](src/grasp_agents/examples/demo/pip) folder. Feel free to copy and paste the code from there to a separate project.
+
+#### 1. Create Project Folder
+
+```bash
+mkdir my-test-pip-app
+cd my-test-pip-app
+```
+
+#### 2. Install Python 3.11.9 (Recommended)
+
+If using [pyenv](https://github.com/pyenv/pyenv):
+
+```bash
+brew install pyenv
+pyenv install 3.11.9
+pyenv local 3.11.9
+```
+
+Open a new terminal after setting the Python version.
+
+#### 3. Create & Activate Virtual Environment
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+#### 4. Install Grasp Agents SDK
+
+If you have a `requirements.txt` file:
+
+```bash
+pip install -r requirements.txt
+```
+
+Or install directly:
+
+```bash
+pip install grasp-agents
+```
+
+#### 5. Example Usage
+
+Create a file, e.g., `hello.py`, and use the same code as above.
+
+#### 6. Run the App
+
+```bash
+python hello.py
+```
+
+---
+
+### Option 3: Poetry-based Project
+
+> **Note:** You can check this sample project code in the [src/grasp_agents/examples/demo/poetry](src/grasp_agents/examples/demo/poetry) folder. Feel free to copy and paste the code from there to a separate project.
+
+#### 1. Create Project Folder
+
+```bash
+mkdir my-test-poetry-app
+cd my-test-poetry-app
+```
+
+#### 2. Install Python 3.11.9 via pyenv
+
+```bash
+brew install pyenv
+pyenv install 3.11.9
+pyenv local 3.11.9
+```
+
+#### 3. Install Poetry Package Manager
+
+If you don't have Poetry, install it:
+
+```bash
+curl -sSL https://install.python-poetry.org | python3 -
+```
+
+Open a new terminal after installing Poetry.
+
+#### 4. Create and Activate a Virtual Environment
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+```
+
+#### 5. Make Poetry Use the Virtual Environment's Python
+
+```bash
+poetry env use $(which python)
+```
+
+#### 6. Install the Grasp Agents SDK
+
+```bash
+poetry install
+```
+
+#### 7. Example Usage
+
+Create a file, e.g., `hello.py`, and use the same code as above.
+
+#### 8. Environment Variables
+
+Ensure you have a `.env` file with your OpenAI API key set:
+
+```
+OPENAI_API_KEY=your_openai_api_key
+```
+
+#### 9. Run the App
+
+```bash
+poetry run python hello.py
+```
+
+## Development
+
+To develop and test the library locally, follow these steps:
+
+### 1. Install UV Package Manager
+
+Make sure [UV](https://github.com/astral-sh/uv) is installed on your system:
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+### 2. Install Dependencies
+
+Create a new virtual environment and install dependencies:
+
+```bash
+uv venv
+source .venv/bin/activate
+uv sync
+```
+
+### 3. Test Example for VS Code
+
+- Install the [Jupyter Notebook extension](https://marketplace.visualstudio.com/items/?itemName=ms-toolsai.jupyter).
+
+- Ensure you have a `.env` file with your OpenAI and Google AI Studio API keys set (see [.env.example](.env.example)).
+
+```
+OPENAI_API_KEY=your_openai_api_key
+GOOGLE_AI_STUDIO_API_KEY=your_google_ai_studio_api_key
+```
+
+- Open [src/grasp_agents/examples/notebooks/agents_demo.ipynb](src/grasp_agents/examples/notebooks/agents_demo.ipynb).
+
+You're now ready to run and experiment with the example notebook.
+
+### 4. Recommended VS Code Extensions
+
+- [Ruff](https://marketplace.visualstudio.com/items/?itemName=charliermarsh.ruff) -- for formatting and code analysis
+- [Pylint](https://marketplace.visualstudio.com/items/?itemName=ms-python.pylint) -- for linting
+- [Pylance](https://marketplace.visualstudio.com/items/?itemName=ms-python.vscode-pylance) -- for type checking

{grasp_agents-0.1.7 → grasp_agents-0.1.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "grasp_agents"
-version = "0.1.7"
+version = "0.1.10"
 description = "Grasp Agents Library"
 readme = "README.md"
 requires-python = ">=3.11.4,<3.12"
@@ -10,6 +10,8 @@ dependencies = [
     "tenacity>=9.1.2",
     "termcolor>=2.4.0,<3",
     "tqdm>=4.66.2,<5",
+    "dotenv>=0.9.9",
+    "pyyaml>=6.0.2",
 ]
 
 [dependency-groups]
@@ -25,6 +27,7 @@ dev = [
     "twine>=5.1.1,<6",
     "ruff>=0.11.8",
     "pyright>=1.1.400",
+    "pip-licenses>=5.0.0",
 ]
 
 [build-system]

grasp_agents-0.1.7/PKG-INFO

@@ -1,203 +0,0 @@
-Metadata-Version: 2.4
-Name: grasp_agents
-Version: 0.1.7
-Summary: Grasp Agents Library
-License-File: LICENSE
-Requires-Python: <3.12,>=3.11.4
-Requires-Dist: httpx<1,>=0.27.0
-Requires-Dist: openai<2,>=1.68.2
-Requires-Dist: tenacity>=9.1.2
-Requires-Dist: termcolor<3,>=2.4.0
-Requires-Dist: tqdm<5,>=4.66.2
-Description-Content-Type: text/markdown
-
-# grasp_agents
-
-<br/>
-<img src="./.assets/grasp.svg" alt="Grasp Agents" width="320" />
-<br/>
-<br/>
-
-[![PyPI version](https://badge.fury.io/py/grasp_agents.svg)](https://badge.fury.io/py/grasp_agents)
-[![Python Versions](https://img.shields.io/pypi/pyversions/grasp_agents?style=flat-square)](https://pypi.org/project/grasp_agents/)
-[![License: MIT](https://img.shields.io/badge/license-MIT-yellow?style=flat-square)](LICENSE)
-
-## Overview
-
-grasp-agents is a modular Python framework for building agentic AI pipelines and applications. It provides reusable agent classes, message handling, LLM integration, memory, and orchestration utilities. The framework is designed for flexibility, composability, and clarity, enabling rapid prototyping and robust development of multi-agent systems.
-
-## Features
-
-- Modular agent base classes
-- Message and memory management
-- LLM and tool orchestration
-- Logging and usage tracking
-- Extensible architecture
-
-## Project Structure
-
-- `src/grasp_agents/` — Core framework modules
-  - `base_agent.py`, `llm_agent.py`, `comm_agent.py`: Agent classes
-  - `agent_message.py`, `agent_message_pool.py`: Messaging
-  - `memory.py`: Memory management
-  - `cloud_llm.py`, `llm.py`: LLM integration
-  - `tool_orchestrator.py`: Tool orchestration
-  - `usage_tracker.py`, `grasp_logging.py`: Usage and logging
-  - `data_retrieval/`, `openai/`, `typing/`, `workflow/`: Extensions and utilities
-- `configs/` — Configuration files
-- `data/` — Logs and datasets
-
-## Quickstart & Installation Variants
-
-### Option 1: UV Package Manager Project
-
-#### 1. Prerequisites
-
-Install the [UV Package Manager](https://github.com/astral-sh/uv):
-
-```bash
-curl -LsSf https://astral.sh/uv/install.sh | sh
-```
-
-#### 2. Create Project & Install Dependencies
-
-```bash
-mkdir my-test-uv-app
-cd my-test-uv-app
-uv init .
-```
-
-Create and activate a virtual environment:
-
-```bash
-uv venv
-source .venv/bin/activate
-```
-
-Add and sync dependencies:
-
-```bash
-uv add grasp_agents
-uv sync
-```
-
-#### 3. Example Usage
-
-Create a file, e.g., `hello.py`:
-
-```python
-from grasp_agents.llm_agent import LLMAgent
-from grasp_agents.base_agent import BaseAgentConfig
-
-agent = LLMAgent(
-    config=BaseAgentConfig(
-        model="gpt-4o-mini",
-        memory=None,  # or your memory implementation
-    )
-)
-
-response = agent.run("Hello, agent!")
-print(response)
-```
-
-Run your script:
-
-```bash
-python hello.py
-```
-
----
-
-### Option 2: PIP-only (requirements.txt-based) Project
-
-#### 1. Create Project Folder
-
-```bash
-mkdir my-test-pip-app
-cd my-test-pip-app
-```
-
-#### 2. Install Python 3.11.9 (Recommended)
-
-If using [pyenv](https://github.com/pyenv/pyenv):
-
-```bash
-brew install pyenv
-pyenv install 3.11.9
-pyenv local 3.11.9
-```
-
-Open a new terminal after setting the Python version.
-
-#### 3. Create & Activate Virtual Environment
-
-```bash
-python -m venv .venv
-source .venv/bin/activate
-```
-
-If you see `ModuleNotFoundError: No module named 'yaml'`, run:
-
-```bash
-pip install pyyaml
-```
-
-#### 4. Install Grasp Agents SDK
-
-If you have a `requirements.txt`:
-
-```bash
-pip install -r requirements.txt
-```
-
-Or install directly:
-
-```bash
-pip install grasp-agents
-```
-
-#### 5. Example Usage
-
-Create a file, e.g., `hello.py`, and use the same code as above.
-
-#### 6. Run the App
-
-```bash
-python hello.py
-```
-
----
-
-## License
-
-MIT License. See [LICENSE](LICENSE) for details.
-
-## Development
-
-To develop and test the library locally, follow these steps:
-
-### 1. Install UV Package Manager
-
-Make sure [UV](https://github.com/astral-sh/uv) is installed on your system:
-
-```bash
-curl -LsSf https://astral.sh/uv/install.sh | sh
-```
-
-### 2. Install Dependencies
-
-Create a new virtual environment and install dependencies:
-
-```bash
-uv venv
-source .venv/bin/activate
-uv sync
-```
-
-### 3. Test Example
-
-- Install the Jupyter Notebook extension for VS Code.
-- Open `src/grasp_agents/examples/notebooks/agents_demo.ipynb` in VS Code.
-- Ensure you have a `.env` file with your OpenAI and Google AI Studio API keys set (see `.env.example`).
-
-You're now ready to run and experiment with the example notebook.

grasp_agents-0.1.7/README.md

@@ -1,190 +0,0 @@
-# grasp_agents
-
-<br/>
-<img src="./.assets/grasp.svg" alt="Grasp Agents" width="320" />
-<br/>
-<br/>
-
-[![PyPI version](https://badge.fury.io/py/grasp_agents.svg)](https://badge.fury.io/py/grasp_agents)
-[![Python Versions](https://img.shields.io/pypi/pyversions/grasp_agents?style=flat-square)](https://pypi.org/project/grasp_agents/)
-[![License: MIT](https://img.shields.io/badge/license-MIT-yellow?style=flat-square)](LICENSE)
-
-## Overview
-
-grasp-agents is a modular Python framework for building agentic AI pipelines and applications. It provides reusable agent classes, message handling, LLM integration, memory, and orchestration utilities. The framework is designed for flexibility, composability, and clarity, enabling rapid prototyping and robust development of multi-agent systems.
-
-## Features
-
-- Modular agent base classes
-- Message and memory management
-- LLM and tool orchestration
-- Logging and usage tracking
-- Extensible architecture
-
-## Project Structure
-
-- `src/grasp_agents/` — Core framework modules
-  - `base_agent.py`, `llm_agent.py`, `comm_agent.py`: Agent classes
-  - `agent_message.py`, `agent_message_pool.py`: Messaging
-  - `memory.py`: Memory management
-  - `cloud_llm.py`, `llm.py`: LLM integration
-  - `tool_orchestrator.py`: Tool orchestration
-  - `usage_tracker.py`, `grasp_logging.py`: Usage and logging
-  - `data_retrieval/`, `openai/`, `typing/`, `workflow/`: Extensions and utilities
-- `configs/` — Configuration files
-- `data/` — Logs and datasets
-
-## Quickstart & Installation Variants
-
-### Option 1: UV Package Manager Project
-
-#### 1. Prerequisites
-
-Install the [UV Package Manager](https://github.com/astral-sh/uv):
-
-```bash
-curl -LsSf https://astral.sh/uv/install.sh | sh
-```
-
-#### 2. Create Project & Install Dependencies
-
-```bash
-mkdir my-test-uv-app
-cd my-test-uv-app
-uv init .
-```
-
-Create and activate a virtual environment:
-
-```bash
-uv venv
-source .venv/bin/activate
-```
-
-Add and sync dependencies:
-
-```bash
-uv add grasp_agents
-uv sync
-```
-
-#### 3. Example Usage
-
-Create a file, e.g., `hello.py`:
-
-```python
-from grasp_agents.llm_agent import LLMAgent
-from grasp_agents.base_agent import BaseAgentConfig
-
-agent = LLMAgent(
-    config=BaseAgentConfig(
-        model="gpt-4o-mini",
-        memory=None,  # or your memory implementation
-    )
-)
-
-response = agent.run("Hello, agent!")
-print(response)
-```
-
-Run your script:
-
-```bash
-python hello.py
-```
-
----
-
-### Option 2: PIP-only (requirements.txt-based) Project
-
-#### 1. Create Project Folder
-
-```bash
-mkdir my-test-pip-app
-cd my-test-pip-app
-```
-
-#### 2. Install Python 3.11.9 (Recommended)
-
-If using [pyenv](https://github.com/pyenv/pyenv):
-
-```bash
-brew install pyenv
-pyenv install 3.11.9
-pyenv local 3.11.9
-```
-
-Open a new terminal after setting the Python version.
-
-#### 3. Create & Activate Virtual Environment
-
-```bash
-python -m venv .venv
-source .venv/bin/activate
-```
-
-If you see `ModuleNotFoundError: No module named 'yaml'`, run:
-
-```bash
-pip install pyyaml
-```
-
-#### 4. Install Grasp Agents SDK
-
-If you have a `requirements.txt`:
-
-```bash
-pip install -r requirements.txt
-```
-
-Or install directly:
-
-```bash
-pip install grasp-agents
-```
-
-#### 5. Example Usage
-
-Create a file, e.g., `hello.py`, and use the same code as above.
-
-#### 6. Run the App
-
-```bash
-python hello.py
-```
-
----
-
-## License
-
-MIT License. See [LICENSE](LICENSE) for details.
-
-## Development
-
-To develop and test the library locally, follow these steps:
-
-### 1. Install UV Package Manager
-
-Make sure [UV](https://github.com/astral-sh/uv) is installed on your system:
-
-```bash
-curl -LsSf https://astral.sh/uv/install.sh | sh
-```
-
-### 2. Install Dependencies
-
-Create a new virtual environment and install dependencies:
-
-```bash
-uv venv
-source .venv/bin/activate
-uv sync
-```
-
-### 3. Test Example
-
-- Install the Jupyter Notebook extension for VS Code.
-- Open `src/grasp_agents/examples/notebooks/agents_demo.ipynb` in VS Code.
-- Ensure you have a `.env` file with your OpenAI and Google AI Studio API keys set (see `.env.example`).
-
-You're now ready to run and experiment with the example notebook.