Skip to content

richardyang92/bamboo

BranchesTags

Repository files navigation

Bamboo - AI 智能绘图与文档生成工作流

一个使用LangGraph框架构建的AI Agent，支持智能绘图和高质量Markdown文档生成。

功能特性

📊 智能绘图

  • ✅ AI驱动：使用DeepSeek模型生成高质量绘图代码
  • 📊 Matplotlib支持：生成各种类型的图表（折线图、柱状图、散点图等）
  • 🔄 自动化流程：用户输入 → 代码生成 → 执行 → 保存图片
  • 📁 本地保存：自动将生成的图表保存到本地
  • 🎯 中文支持：完美支持中文显示
  • 🛡️ 空白图像防护：智能检测并防止生成空白图像，包含详细的错误检查清单
  • 🎨 流程图支持：支持生成专业的流程图和架构图
  • 🧠 智能识别：根据描述类型自动选择最佳绘图策略（力学图、流程图等）

📝 文档生成

  • ✨ AI写作：使用DeepSeek模型生成高质量Markdown文档
  • 🧮 数学公式：完美支持LaTeX数学公式渲染（基于KaTeX）
  • 📚 结构化内容：自动生成大纲、章节、示例代码
  • 🎨 格式规范：遵循标准的Markdown语法规范
  • 📖 多领域支持：技术文档、教程、学术文章等

🖼️ 带图片的文档生成

  • 🎯 智能识别：自动识别文档中需要图片的部分
  • 📊 图表生成：自动生成相关的图表并整合到文档中
  • 🔗 无缝集成：图片与文档内容完美融合
  • 💡 灵活配置：支持自定义图片生成选项

🌐 Web界面

  • 📡 实时更新：通过WebSocket实时推送执行进度
  • 📜 历史记录：查看和管理所有生成的图表和文档
  • 🖼️ 预览功能：实时预览生成的图表和文档
  • 📥 一键下载：方便地下载生成的文件
  • 🌓 主题切换：支持深色/浅色主题
  • 🚀 快速启动：提供便捷的启动脚本

快速开始

1. 安装依赖

# 使用虚拟环境（推荐）
python -m venv venv
source venv/bin/activate  # Linux/Mac
# venv\Scripts\activate  # Windows

# 安装所有依赖
pip install -r requirements.txt

2. 配置API密钥

复制并编辑环境变量文件：

cp .env.example .env

编辑 .env 文件，添加你的DeepSeek API密钥：

DEEPSEEK_API_KEY=你的DeepSeek密钥

💡 提示：详细的DeepSeek API配置指南请参考 doc/DEEPSEEK_SETUP.md

使用方式

方式一：快速启动脚本（推荐）

使用提供的启动脚本：

chmod +x start.sh  # 首次运行需要添加执行权限
./start.sh

脚本会自动检查虚拟环境和配置文件，然后启动Web服务器。

方式二：Web界面

手动启动Web服务器：

# 确保已激活虚拟环境
source venv/bin/activate

# 启动服务器
python app.py

然后在浏览器中访问：http://localhost:5001

Web界面功能：

  • 📊 智能绘图：实时输入绘图需求，生成图表
  • 📝 文档生成：输入主题，自动生成高质量Markdown文档
  • 📊 可视化展示：实时显示工作流执行步骤
  • ⚡ 实时更新：WebSocket推送状态更新
  • 🖼️ 预览功能：预览生成的图表和文档
  • 📜 历史记录：访问 /history 页面查看所有生成内容
  • 📥 一键下载：下载生成的图片和文档
  • 🗑️ 管理功能：删除不需要的历史记录

方式三：命令行模式

绘图功能

python draw_pic.py "你的绘图需求"

示例：

python draw_pic.py "绘制一个简单的折线图，显示2023年每个月的销售额"

文档生成功能

python write_md.py "文档主题"

示例：

python write_md.py "量子力学基础教程"

带图片的文档生成功能

python write_md_with_images.py "文档主题"

示例：

python write_md_with_images.py "量子力学基础教程"

此功能会自动识别文档中需要图表的部分，并生成相关图表整合到文档中。

工作流程

📊 绘图工作流

系统采用LangGraph构建的4步工作流：

  1. 润色提示词 (refine_prompt)

    • 增强用户的绘图需求
    • 添加必要的绘图要求和规范
    • 包含物理约束和绘图最佳实践

  2. 生成绘图代码 (generate_code)

    • 调用DeepSeek模型
    • 生成完整的matplotlib绘图代码
    • 智能识别绘图类型（数据图表、力学示意图、流程图等）
    • 根据类型应用专门的绘图策略和提示词
    • 确保代码可直接执行

  3. 执行绘图代码 (execute_code)

    • 在安全环境中执行生成的代码
    • 内置空白图像防护机制
    • 验证数据有效性（检查NaN、Inf、全零等）
    • 显式设置坐标轴范围和颜色
    • 自动生成唯一文件名
    • 保存图表到本地

  4. 验证图片保存 (save_image)

    • 验证图片是否成功生成
    • 获取图片大小等信息
    • 返回执行结果

📝 文档生成工作流

文档生成采用类似的5步工作流：

  1. 润写作需求 (refine_prompt)

    • 增强用户的写作需求
    • 添加文档写作要求和格式规范
    • 包含数学公式KaTeX兼容性要求

  2. 生成文档大纲 (generate_outline)

    • 调用DeepSeek模型生成结构化大纲
    • 确保逻辑清晰、层次分明
    • 覆盖主题的所有重要方面

  3. 生成文档内容 (generate_content)

    • 根据大纲展开完整内容
    • 使用标准Markdown语法
    • 自动修复LaTeX公式转义问题

  4. 保存文档 (save_document)

    • 保存到 docs/ 目录
    • 自动生成唯一文件名（带时间戳）
    • 返回文件路径和大小

  5. 验证文档 (verify_document)

    • 验证文件是否成功保存
    • 统计文档字数、行数等信息

🖼️ 带图片的文档生成工作流

带图片的文档生成采用增强的8步工作流：

  1. 润写作需求 (refine_prompt)

    • 增强用户的写作需求
    • 添加文档写作要求和格式规范
    • 包含图片生成指令

  2. 生成文档大纲 (generate_outline)

    • 调用DeepSeek模型生成结构化大纲
    • 确保逻辑清晰、层次分明
    • 标注需要图表的位置

  3. 生成文档内容 (generate_content)

    • 根据大纲展开完整内容
    • 使用标准Markdown语法
    • 在适当位置插入图片占位符

  4. 识别图片需求 (identify_image_requests)

    • 分析文档内容，识别需要生成的图表
    • 确定每个图片的类型和描述

  5. 生成图表 (generate_images)

    • 为每个图片需求生成对应的绘图代码
    • 智能识别图表类型（流程图、数据图表、力学图等）
    • 针对不同类型使用优化的绘图策略
    • 执行代码并保存图片
    • 收集所有生成的图片路径

  6. 整合图片到文档 (embed_images)

    • 将生成的图片路径替换文档中的占位符
    • 生成包含图片的完整文档内容

  7. 保存文档 (save_document)

    • 保存到 docs/ 目录
    • 自动生成唯一文件名（带时间戳）
    • 返回文件路径和大小

  8. 验证文档 (verify_document)

    • 验证文件和图片是否成功保存
    • 统计文档字数、行数、图片数量等信息

代码结构

bamboo/
├── draw_pic.py          # 绘图工作流核心逻辑
├── write_md.py          # 文档生成工作流核心逻辑
├── write_md_with_images.py  # 带图片的文档生成工作流
├── app.py               # Web服务器和API接口
├── start.sh             # 快速启动脚本
├── AGENTS.md            # 开发指南和代码规范
├── templates/
│   ├── index.html       # Web前端主界面
│   └── history.html     # 历史记录页面
├── doc/
│   └── DEEPSEEK_SETUP.md # DeepSeek API配置指南
├── images/              # 生成的图表保存目录
├── docs/                # 生成的文档保存目录
├── requirements.txt     # Python依赖包
├── .env                 # 环境变量配置
├── .env.example         # 环境变量示例
├── .gitignore           # Git忽略文件配置
├── LICENSE              # Apache 2.0许可证
└── README.md            # 项目文档

主要文件说明

  • draw_pic.py: 绘图工作流，定义图表生成的各个节点
  • write_md.py: 文档生成工作流，定义文档创作的各个节点
  • write_md_with_images.py: 带图片的文档生成工作流，支持自动生成图表并整合到文档中
  • app.py: Flask Web服务器，提供RESTful API和WebSocket支持
  • AGENTS.md: 开发指南，包含代码风格规范、工作流模式和API集成说明
  • start.sh: 快速启动脚本，自动检查环境并启动服务
  • templates/index.html: 响应式Web界面，支持绘图和文档生成
  • templates/history.html: 历史记录页面，展示所有生成的图表和文档
  • doc/DEEPSEEK_SETUP.md: 详细的DeepSeek API配置和获取指南

API 接口

Web服务器提供以下API接口：

绘图相关

POST /api/workflow

启动新的绘图工作流

请求体：

{
  "prompt": "绘制一个折线图"
}

文档相关

POST /api/document/workflow

启动新的文档生成工作流

请求体：

{
  "prompt": "量子力学基础教程",
  "options": {
    "includeCode": true,
    "includeTables": true
  }
}

POST /api/document/workflow-with-images

启动带图片的文档生成工作流

请求体：

{
  "prompt": "量子力学基础教程"
}

该接口会自动识别文档中需要图表的部分，并生成相关图表整合到文档中。

GET /api/documents/

获取指定的文档文件

DELETE /api/documents/

删除指定的文档文件

通用接口

GET /api/history

获取所有历史记录（图表和文档）

GET /api/images

列出所有生成的图片

GET /api/images/

获取指定的图片文件

DELETE /api/images/

删除指定的图片文件

POST /api/clear

清除所有历史记录

WebSocket事件

  • status_update: 接收工作流状态更新
  • document_update: 接收文档生成进度更新
  • connect: 客户端连接
  • disconnect: 客户端断开

输出示例

📊 绘图输出

1. 正在生成绘图代码...
2. 正在执行绘图代码...
3. 正在验证图片保存...
✅ 绘图成功！图片已保存到: plot.png
📏 图片大小: 234.16 KB
📝 生成的代码:
import matplotlib.pyplot as plt
...
📍 图片绝对路径: /Users/yangyang/Projects/bamboo/images/plot.png

📝 文档生成输出

1. 正在润色写作需求...
✅ 原始需求: '量子力学基础教程'
✅ 增强后的提示词已生成

2. 正在生成文档大纲...
✅ 文档大纲生成完成

3. 正在生成文档内容...
✅ Markdown 文档内容生成完成

4. 正在保存文档...
✓ 文档已保存: docs/doc_量子力学基础教程_20260123_180000.md (大小: 12345 字节)

5. 正在验证文档...
✓ 文档验证成功
[STATS] 行数: 245, 字符数: 12345, 标题数: 28

生成的文档包含：

  • 清晰的章节结构
  • 标准的Markdown格式
  • LaTeX数学公式（支持KaTeX渲染）
  • 代码示例和说明
  • 表格和列表

注意事项

  1. API密钥安全：不要将你的API密钥提交到版本控制系统
  2. 模型选择：目前使用的是DeepSeek模型，提供高性价比的代码生成能力
  3. 代码安全：生成的代码会在安全环境中执行，但仍建议谨慎处理未知输入
  4. 中文显示：程序已配置中文支持，但可能需要根据你的系统调整字体设置
  5. 端口配置：默认使用5001端口，如需修改请编辑 app.py

技术栈

后端

  • Web框架: Flask 3.0.0
  • 实时通信: Flask-SocketIO 5.3.6 + Eventlet
  • 工作流引擎: LangGraph 0.0.28
  • AI模型: DeepSeek (兼容OpenAI API)
  • 绘图: Matplotlib >= 3.9.0
  • 数值计算: NumPy >= 2.0.0

前端

  • 基础: 原生 HTML/CSS/JavaScript
  • Markdown渲染: Marked.js
  • 数学公式: KaTeX
  • 实时通信: Socket.IO Client

DeepSeek API 优势

  • 💰 高性价比：极具竞争力的价格，¥1/百万tokens
  • 🎁 免费额度：新用户通常有免费试用额度
  • 💻 代码能力强：特别擅长代码生成和理解
  • 🔌 兼容性好：使用标准的OpenAI接口，集成简单

详细配置请参考 DeepSeek配置指南

常见问题

1. 端口被占用

如果5001端口被占用，可以修改 app.py 最后一行：

socketio.run(app, debug=True, host='0.0.0.0', port=5002)  # 改为5002

2. 生成的图片中文显示异常

系统已配置多种中文字体备选方案。如果仍有问题，请检查系统字体安装情况。

3. API调用失败

请检查：

  • API密钥是否正确配置在 .env 文件中
  • 网络连接是否正常
  • API额度是否充足
  • 是否按照 DeepSeek配置指南 正确配置

4. 启动脚本无执行权限

chmod +x start.sh

5. 虚拟环境激活失败

确保使用正确的激活命令：

  • Linux/Mac: source venv/bin/activate
  • Windows: venv\Scripts\activate

扩展建议

绘图功能

  • 支持更多绘图库（seaborn、plotly等）
  • 添加图表编辑和重新生成功能
  • 实现代码模板管理
  • 支持批量绘图
  • 添加数据导入功能（CSV、Excel等）
  • 实现图表分享功能
  • 添加图表导出为SVG/PDF功能
  • 支持自定义图表主题和样式

文档功能

  • 支持更多输出格式（PDF、HTML、Word等）
  • 添加文档模板系统
  • 实现文档续写和编辑功能
  • 支持多语言文档生成
  • 添加参考文献管理
  • 实现文档版本控制
  • 支持协作文档编辑
  • 添加文档导出和分享功能

通用功能

  • 添加用户认证系统
  • 实现历史记录持久化存储到数据库
  • 添加使用统计和分析
  • 实现API限流和配额管理

许可证

本项目采用 Apache License 2.0 许可证。详见 LICENSE 文件。

致谢

Made with ❤️ by richardyang92

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

No packages published

Contributors 2

  •  
  •  

Languages