EvoAgentX

环境要求

• Python 环境（README 未指定具体版本，本地开发建议用 conda 等虚拟环境）
• 已安装 pip
• 使用 OpenAI 等 LLM 时必须准备的 API Key（如 OPENAI_API_KEY）

安装与启动步骤

1. 1pip 安装框架

   官方推荐方式，一条命令安装发布到 PyPI 的 evoagentx 包，适合直接用不想改源码的用户。

   pip install evoagentx

   复制

2. 2从 Git 仓库安装

   不想装发布包时，可直接用 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
   # 或者安装为开发模式
   pip install -e .

   复制

4. 4设置 API Key(类 Unix)

   在 Linux/macOS 终端导出环境变量，把占位符换成自己的真实 Key。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

5. 5设置 API Key(Windows)

   Windows 命令提示符用 set，PowerShell 用 $env: 且值必须加双引号。

   set OPENAI_API_KEY=sk-xxxxxxxx
   # Windows PowerShell
   $env:OPENAI_API_KEY="sk-xxxxxxxx"

   复制

6. 6改用 .env 文件

   在项目根目录创建 .env 文件写入 Key，再用 dotenv 的 load_dotenv() 自动加载，便于多项目复用。

7. 7定义 LLM 配置

   在 Python 代码里构造 OpenAILLMConfig，指定模型名、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 不报错。

常见问题

注意事项

• 命令中的 <your-openai-api-key> 占位符要替换成自己的真实密钥。
• 建议把 .env 加入 .gitignore，避免密钥被提交泄露。
• 更完整的本地安装与 conda 配置步骤见仓库 docs/installation.md。
• README 未给出运行示例脚本与端口信息，实际用法以官网文档为准。