FinRobot

环境要求

• 已安装 conda（Miniconda/Anaconda）
• Python 3.10（README 推荐用 conda 创建该版本环境）
• OpenAI API Key（用于 LLM 调用）
• Finnhub API Key（行情数据）
• financialmodelingprep 与 sec-api 的 API Key（生成财务报告时需要）

安装与启动步骤

1. 1创建并激活环境

   按 README 推荐用 conda 新建一个 Python 3.10 的独立环境，避免与系统已有包冲突，随后激活该环境。

   conda create --name finrobot python=3.10
   conda activate finrobot

   复制

2. 2获取项目代码

   用 git 克隆官方仓库，或手动下载后进入项目根目录，后续配置文件和教程都在这个目录里。

   git clone https://github.com/AI4Finance-Foundation/FinRobot.git
   cd FinRobot

   复制

3. 3安装 finrobot

   推荐从 PyPI 安装最新发布版；若想直接基于本仓库代码开发，则在项目根目录改用 pip install -e . ，两者选其一即可。

   pip install -U finrobot

   复制

4. 4配置 OpenAI 密钥

   把 OAI_CONFIG_LIST_sample 重命名为 OAI_CONFIG_LIST，删除文件内的四行注释，再把自己的 OpenAI API Key 填进去。

5. 5配置数据源密钥

   把 config_api_keys_sample 重命名为 config_api_keys，删除注释，填入 finnhub 的 key；若要生成财务报告还需填 FMP 与 SEC 的 key。

6. 6运行教程与示例

   配置完成后即可从仓库的 tutorials 与 demos 开始上手，直接在 Jupyter Notebook 中运行示例流程。

关键配置

如何确认成功

在 finrobot 环境中打开仓库 tutorials 或 demos 里的 Notebook，能正常加载配置并调用模型、拉取数据即表示安装配置成功。

常见问题

注意事项

• 两个配置文件都必须先从 *_sample 重命名，再删除文件内注释并填入自己的真实密钥。
• 获取项目代码后要 cd 进入 FinRobot 目录，源码安装（pip install -e .）需在该目录下执行。
• README 未给出启动命令，安装完成后建议直接从仓库的 tutorials 和 demos 入手。