HelloAgents

环境要求

• 已安装 Python 环境（README 未指定具体版本）
• pip 可正常使用，能访问 PyPI 安装包
• 一个 OpenAI 兼容的 LLM 服务：模型名、API Key、Base URL
• 如需阅读源码/跟随教程，需安装 git 并可访问 GitHub 或 AtomGit 镜像

安装与启动步骤

1. 1安装框架

   HelloAgents 以 Python 包形式发布，直接通过 pip 安装即可，无需 Docker 或额外服务。

   pip install hello-agents

   复制

2. 2配置模型密钥

   在项目目录创建 .env 文件，填入模型名、API Key 与 Base URL，供 HelloAgentsLLM 读取。

   LLM_MODEL_ID=your-model-name
   LLM_API_KEY=your-api-key-here
   LLM_BASE_URL=your-api-base-url

   复制

3. 3编写示例代码

   从包中导入 ReActAgent、HelloAgentsLLM 与 ToolRegistry，注册内置工具后创建 Agent 并运行任务。

   from hello_agents import ReActAgent, HelloAgentsLLM, ToolRegistry
   from hello_agents.tools.builtin import ReadTool, WriteTool, TodoWriteTool
   
   llm = HelloAgentsLLM()
   registry = ToolRegistry()
   registry.register_tool(ReadTool())
   registry.register_tool(WriteTool())
   registry.register_tool(TodoWriteTool())
   
   agent = ReActAgent("assistant", llm, tool_registry=registry)
   agent.run("分析项目结构并生成报告")

   复制

4. 4运行示例

   将上面的代码保存为 .py 文件并执行，观察 Agent 调用工具完成任务的过程与输出。

5. 5切换学习分支

   若跟随 Datawhale 教程学习，README 建议切换到 learn_version 分支，其代码与教程正文完全对应。

   git clone -b learn_version https://github.com/jjyaoao/HelloAgents.git

   复制

关键配置

如何确认成功

执行示例脚本后，agent.run 正常返回分析结果且无报错；若报错先检查 .env 中的三项 LLM 配置是否正确。

常见问题

注意事项

• README 中未给出 Python 版本要求、端口或部署路径，安装仅为 pip 安装这一种方式。
• HelloAgentsLLM 基于 OpenAI 原生 API 构建，因此 API Key 与 Base URL 需兼容 OpenAI 接口格式。
• 仓库同时维护学习版与开发版，克隆代码前先确认所需分支，避免与教程内容不一致。
• README 节选内容不完整，实际导入路径与示例代码请以仓库最新文档为准。