Metadata-Version: 2.4
Name: consultant-agent
Version: 0.3.0
Summary: 一个专业的咨询顾问 AI Agent，支持文档分析、联网搜索、报告生成（跨平台支持 Windows/macOS/Linux）
Author: xiaoboluo
License-Expression: MIT
Project-URL: Homepage, https://github.com/xiaoboluo/consultant-agent
Project-URL: Repository, https://github.com/xiaoboluo/consultant-agent
Project-URL: Documentation, https://github.com/xiaoboluo/consultant-agent#readme
Keywords: ai,agent,consultant,llm,langchain,document-analysis
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: langchain>=0.2.0
Requires-Dist: langchain-openai>=0.1.0
Requires-Dist: langgraph>=0.1.0
Requires-Dist: pdfplumber>=0.10.0
Requires-Dist: python-docx>=1.0.0
Requires-Dist: python-pptx>=0.6.0
Requires-Dist: openpyxl>=3.1.0
Requires-Dist: pandas>=2.0.0
Requires-Dist: requests>=2.31.0
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: duckduckgo-search>=6.0.0
Requires-Dist: python-dotenv>=1.0.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: black>=24.0.0; extra == "dev"
Requires-Dist: ruff>=0.3.0; extra == "dev"
Provides-Extra: web
Requires-Dist: gradio>=4.0.0; extra == "web"
Requires-Dist: fastapi>=0.110.0; extra == "web"
Requires-Dist: uvicorn>=0.27.0; extra == "web"
Provides-Extra: ocr
Requires-Dist: pytesseract>=0.3.10; extra == "ocr"
Requires-Dist: pillow>=10.0.0; extra == "ocr"
Requires-Dist: pymupdf>=1.23.0; extra == "ocr"
Provides-Extra: windows
Requires-Dist: pyreadline3>=3.4.0; extra == "windows"

# Consultant Agent

一个专业的咨询顾问 AI Agent，支持文档分析、联网搜索、报告生成。

[![PyPI version](https://badge.fury.io/py/consultant-agent.svg)](https://badge.fury.io/py/consultant-agent)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey.svg)]()

## 特性

- **文档分析**: 支持 PDF、Word、Excel、PPT 等多种格式
- **联网搜索**: 集成 DuckDuckGo 搜索，获取最新信息
- **报告生成**: 自动生成专业的咨询分析报告
- **跨平台**: 支持 Windows、macOS、Linux
- **命令补全**: 智能命令提示和自动补全
- **权限管理**: 灵活的工具权限控制系统

## 安装

### 基础安装

```bash
pip install consultant-agent
```

### 完整安装（包含 OCR 功能）

```bash
pip install consultant-agent[ocr]
```

### Windows 用户

```bash
# 基础安装
pip install consultant-agent

# 推荐：安装命令行增强（支持命令历史和自动补全）
pip install consultant-agent[windows]

# 或手动安装
pip install pyreadline3
```

### macOS 用户

```bash
pip install consultant-agent

# OCR 功能需要安装 Tesseract
brew install tesseract
brew install tesseract-lang  # 中文支持
```

### Linux 用户

```bash
pip install consultant-agent

# OCR 功能需要安装 Tesseract
sudo apt-get install tesseract-ocr tesseract-ocr-chi-sim  # Ubuntu/Debian
sudo yum install tesseract tesseract-langpack-chi_sim     # CentOS/RHEL
```

## 快速开始

### 1. 配置 API Key

创建 `.env` 文件：

```bash
# OpenAI 兼容的 API（支持 DeepSeek、OpenAI 等）
OPENAI_API_KEY=your-api-key
OPENAI_BASE_URL=https://api.deepseek.com  # 可选，默认 OpenAI

# 或使用 DeepSeek
DEEPSEEK_API_KEY=your-deepseek-key
```

### 2. 运行 Agent

```bash
consultant-agent
```

或直接运行 Python 脚本：

```bash
python agent_v3.py
```

### 3. 使用示例

```
你: /产品研究 Coze、Dify、FastGPT
你: /公司研究 腾讯
你: /热点研究 GPT-5 发布
你: 帮我分析这份报告 ~/Documents/report.pdf
你: 搜索一下最新的 AI Agent 技术趋势
```

## 命令列表

| 命令 | 说明 |
|------|------|
| `/产品研究 <产品列表>` | 生成产品对比分析报告 |
| `/公司研究 <公司名>` | 生成公司战略分析报告 |
| `/热点研究 <事件>` | 生成热点事件分析报告 |
| `/help` | 显示帮助信息 |
| `/tools` | 列出所有可用工具 |
| `/skills` | 列出所有自定义 Skill |
| `/clear` | 清空对话历史 |
| `/quit` | 退出程序 |

## 支持的文档格式

| 格式 | 读取 | 编辑 | 说明 |
|------|:----:|:----:|------|
| PDF | ✅ | ❌ | 支持文字提取和 OCR |
| Word (.docx) | ✅ | ✅ | 支持表格插入 |
| Excel (.xlsx) | ✅ | ✅ | 支持数据分析 |
| PowerPoint (.pptx) | ✅ | ✅ | 支持幻灯片编辑 |
| Markdown | ✅ | ✅ | 原生支持 |
| 图片 | ✅ | ❌ | 需要 OCR 依赖 |

## 项目结构

```
consultant-agent/
├── agent_v3.py          # 主程序入口
├── tools/               # 工具集
│   ├── document_tools.py    # 文档处理工具
│   ├── bash_tool.py         # 命令执行工具
│   ├── skill_manager.py     # Skill 管理
│   └── ...
├── prompts/             # 提示词模板
│   ├── consulting_prompt.py # 咨询方法论
│   └── ...
├── skills/              # 自定义 Skill
└── outputs/             # 生成的报告
```

## 环境变量

| 变量 | 说明 | 默认值 |
|------|------|--------|
| `OPENAI_API_KEY` | OpenAI API Key | - |
| `OPENAI_BASE_URL` | API Base URL | `https://api.openai.com/v1` |
| `DEEPSEEK_API_KEY` | DeepSeek API Key | - |
| `CODE_RAG_PATH` | 代码 RAG 路径 | `~/Documents/AI_Agent/code-rag` |
| `CODE_SEARCH_PATH` | 代码搜索路径 | `~/Documents/IOS_XP/XPMotors_IOS` |

## 更新日志

### v0.3.0 (2024-07)
- **新增**: Windows 系统完整支持
- **新增**: 表格插入时自动复制现有样式
- **优化**: 跨平台路径处理
- **优化**: Shell 命令执行兼容性
- **修复**: readline 在 Windows 上的兼容问题

### v0.2.0
- 初始发布版本
- 支持文档分析、联网搜索、报告生成

## 开发

```bash
# 克隆仓库
git clone https://github.com/xiaoboluo/consultant-agent.git
cd consultant-agent

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # Linux/macOS
# 或 .\venv\Scripts\activate  # Windows

# 安装开发依赖
pip install -e ".[dev]"

# 运行测试
pytest
```

## 许可证

MIT License - 详见 [LICENSE](LICENSE) 文件

## 贡献

欢迎提交 Issue 和 Pull Request！

## 作者

xiaoboluo
