algo-setup

设置本地 Python 环境，以构建和运行 OpenAlgo 双模式交易策略。

参数

$0（可选）= Python 解释器名称（python、python3、python3.12）。默认值：python。

操作步骤

1. 检测操作系统（Windows / macOS / Linux），使用 uname -s 或 os.name。为 TA-Lib C 库（pip install ta-lib 依赖此库）使用对应操作系统的安装命令。

2. 创建 venv（如果尚不存在）：

   python -m venv venv
   

3. 安装 TA-Lib C 库（Python ta-lib 的必需依赖）：

   • macOS：brew install ta-lib
   • Ubuntu/Debian：sudo apt install libta-lib-dev（可能需要先运行 sudo apt update）
   • Windows：pip install ta-lib 使用预构建的 wheel，无需安装 C 库

4. 激活 venv 并从 requirements.txt 安装 Python 软件包：

   # Linux/macOS
   source venv/bin/activate
   pip install -r requirements.txt
   
   # Windows
   venv\Scripts\activate
   pip install -r requirements.txt
   

5. 创建目录结构：

   strategies/
       (empty - generated strategies will land here)
   backtests/
       (empty - generated backtest CSV/HTML output lands here)
   

6. 创建 .env：复制 .env.sample，并提示用户填写 OPENALGO_API_KEY：

   cp .env.sample .env
   

7. 运行以下命令验证安装：

   from openalgo import api, ta
   import vectorbt as vbt
   import talib
   import sklearn
   import xgboost
   print("OK")
   

8. 打印后续步骤：

   Setup complete. Next:
     1. Edit .env and set OPENALGO_API_KEY
     2. Make sure OpenAlgo is running at http://127.0.0.1:5000
     3. Generate a strategy: /algo-strategy ema-crossover SBIN NSE 5m
   

避免事项

• 输出中不要使用图标或表情符号
• 不要在 shell 中自动运行 OPENALGO_API_KEY=...——用户会手动将其粘贴到 .env
• 第 4 步之后不要假设 venv 外存在 pip——始终先激活 venv

用户已有 venv 时

跳过第 2 步。激活现有 venv，使用它运行 pip install -r requirements.txt，然后继续。

故障情况

• 在 Linux 上安装 TA-Lib 失败：告知用户运行 sudo apt update && sudo apt install build-essential libta-lib-dev。如果仍然失败（较旧的发行版），建议跳过 TA-Lib，并在策略中仅使用 INDICATOR_LIB="openalgo"。
• OpenAlgo 未运行：设置流程仍会完成，且验证安装步骤中的 from openalgo import api 可以正常工作（SDK 安装无需网络）。实际连接会在 /algo-strategy 中验证。