Metadata-Version: 2.4
Name: hyperagent
Version: 0.0.3
Summary: multimoda Agent framework
Author-email: Yaqiang Sun <sunyaking@163.com>
License: GPL-3.0
Requires-Python: <3.14,>=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.13.2
Requires-Dist: fastmcp>=2.14.2
Requires-Dist: ms-agent>=1.5.2
Requires-Dist: ms-enclave[docker]>=0.0.4
Requires-Dist: omegaconf>=2.3.0
Requires-Dist: pandas>=2.3.3
Provides-Extra: research
Requires-Dist: arxiv; extra == "research"
Requires-Dist: docling<=2.38.1; extra == "research"
Requires-Dist: docling-core<=2.38.2; extra == "research"
Requires-Dist: exa-py; extra == "research"
Requires-Dist: google-search-results; extra == "research"
Requires-Dist: json5; extra == "research"
Requires-Dist: markdown; extra == "research"
Requires-Dist: modelscope; extra == "research"
Requires-Dist: openai; extra == "research"
Requires-Dist: Pillow; extra == "research"
Requires-Dist: python-dotenv; extra == "research"
Requires-Dist: ray[default]>=2.53.0; extra == "research"
Requires-Dist: requests; extra == "research"
Dynamic: license-file

# 🤖 HyperAgent

<p align="center">
  <b>一个强大的多模态智能代理框架</b>
</p>

<p align="center">
  <a href="#功能特性">⚡ 特性</a> •
  <a href="#安装">📦 安装</a> •
  <a href="#使用方法">🚀 使用</a> •
  <a href="docs/code_structure.md">🏗️ 项目结构</a> •
  <a href="examples/README.md">💡 示例说明</a> •
  <a href="#许可证">📄 许可证</a>
</p>

---

HyperAgent 是一个多模态智能代理框架，旨在创建和管理具有多种技能的智能代理。它支持通过技能扩展代理功能，提供灵活的智能体开发和部署能力。

## ✨ 功能特性

- 🧠 **多模态智能代理支持** - 支持多种输入输出模式
- 🔧 **可扩展的技能系统** - 通过技能轻松扩展代理功能
- 🌐 **支持 OpenAI API 兼容的模型接口** - 可使用各种 LLM 模型
- 🛡️ **内置沙箱环境支持** - 安全执行外部代码
- ⚙️ **可配置的工作流管理** - 灵活配置代理行为

## 📦 安装

### 环境要求

- 🐍 Python >= 3.12

### 安装步骤

1. 📥 克隆项目：

   ```bash
   pip install hyperagent
   ```
   or
   ```bash
   pip install hyperagent[research]
   ```

## 🚀 使用方法

### 命令行方式

```bash
hyperagent
```

### 作为库使用

```python
from hyperagent.agent import create_agent_skill

# 🤖 创建智能代理
agent = create_agent_skill(config)
```

### 🧪 运行示例

项目包含示例，位于 [examples/agent_skills](examples/agent_skills) 目录下：

```bash
cd examples/agent_skills
python run.py
```

## ⚙️ 配置说明

HyperAgent 支持通过配置文件自定义代理行为。配置文件使用 OmegaConf 格式，支持以下选项：

- `work_dir`: 📁 工作目录
- `skills_dir`: 🔧 技能目录
- `example_data_dir`: 📊 示例数据目录
- `use_sandbox`: 🛡️ 是否使用沙箱环境

## 🔧 技能系统

HyperAgent 的技能系统允许代理执行特定任务。技能可以包括脚本、文档和资源文件。每个技能包含：

- `SKILL.md`: 📝 技能说明文档
- `scripts/`: 💻 可执行脚本
- 📁 相关资源文件

## 🧪 开发

### 运行测试

```bash
# 从项目根目录运行
python -m pytest tests/
```

### 🤝 贡献

欢迎提交 Issue 和 Pull Request 来改进项目。

## 📄 许可证

本项目使用 GPL-3.0 许可证。详情请参见 [LICENSE](LICENSE) 文件。
