EvoAgentX

环境要求

• Python 环境（项目基于 Python）
• pip 包管理工具
• 有效的 OpenAI API Key（用于调用 LLM）
• 可选：conda 等虚拟环境（详细配置见官方安装指南）

安装与启动步骤

1. 1pip 安装

   README 推荐的安装方式，一行命令装上 evoagentx 包，适合直接使用框架的用户。

   pip install evoagentx

   复制

2. 2从仓库安装

   不下载源码，直接通过 pip 从 GitHub 仓库安装最新版本。

   pip install git+https://github.com/EvoAgentX/EvoAgentX.git

   复制

3. 3克隆源码安装

   本地开发或需要详细配置时使用，克隆后进入目录并安装依赖。

   git clone https://github.com/EvoAgentX/EvoAgentX.git
   cd EvoAgentX
   pip install -r requirements.txt

   复制

4. 4开发模式安装

   在已克隆的仓库目录中执行，改动源码后无需重新安装即可生效。

   pip install -e .

   复制

5. 5配置 API Key

   Linux/macOS 通过 export 设置环境变量，把示例密钥换成你自己的真实值。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

6. 6Windows 设置密钥

   Windows PowerShell 用 $env: 设置，值两侧的英文引号必须保留。

   $env:OPENAI_API_KEY="sk-xxxxxxxx"

   复制

7. 7改用 .env 文件

   .env 放在项目根目录，之后在 Python 里用 load_dotenv() 自动读取，避免硬编码密钥。

   OPENAI_API_KEY=sk-xxxxxxxx

   复制

8. 8编写 LLM 配置

   用 OpenAILLMConfig 指定模型名、密钥和响应开关；README 未给出导入路径，请参考官方安装指南。

   from dotenv import load_dotenv
   import os
   
   load_dotenv()
   OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
   
   openai_config = OpenAILLMConfig(
       model="gpt-4o-mini",
       openai_key=OPENAI_API_KEY,
       stream=True,
       output_response=True
   )

   复制

关键配置

如何确认成功

在 Python 中用 os.getenv("OPENAI_API_KEY") 能取到密钥，且 OpenAILLMConfig 配置代码执行不报错即配置成功。

常见问题

注意事项

• 不要把 API Key 直接提交到仓库，建议把 .env 加入 .gitignore。
• 建议在独立的虚拟环境（venv/conda）中安装，避免与系统 Python 包冲突。
• README 节选未给出 OpenAILLMConfig 的模块导入路径，实际导入方式请参考官方安装指南 docs/installation.md。