lumibot

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• Python 环境（README 为 Python 包，未标注具体版本）
• 已安装 lumibot 包（README 未给出安装命令，需查官方文档）
• Alpaca 账户及其 API Key / Secret（纸面或实盘）
• 可访问官方文档 lumibot.lumiwealth.com 查看完整安装说明

安装与启动步骤

1. 1跑内置回测示例

   用 README 提供的示例命令验证框架可用：重放历史数据与模拟订单，不涉及真实资金。

   python -m lumibot.example_strategies.stock_buy_and_hold

   复制

2. 2编写券商运行代码

   沿用回测里的 MyStrategy 类，把 MyStrategy.backtest(...) 换成下面的券商运行代码，用 Alpaca 连接。

   import os
   from lumibot.brokers import Alpaca
   from lumibot.traders import Trader
   
   ALPACA_CONFIG = {
       "API_KEY": os.environ["ALPACA_API_KEY"],
       "API_SECRET": os.environ["ALPACA_API_SECRET"],
       "PAPER": os.environ.get("ALPACA_IS_PAPER", "true").lower() != "false",
   }
   
   broker = Alpaca(ALPACA_CONFIG)
   strategy = MyStrategy(broker=broker)
   
   trader = Trader()
   trader.add_strategy(strategy)
   trader.run_all()

   复制

3. 3配置 Alpaca 密钥

   设置三个环境变量再运行脚本；ALPACA_IS_PAPER=true 表示纸面交易，务必先用纸面验证。

   export ALPACA_API_KEY='your-alpaca-key'
   export ALPACA_API_SECRET='your-alpaca-secret'
   export ALPACA_IS_PAPER=true

   复制

4. 4启动纸面交易

   在设置好环境变量的终端运行你的策略脚本，用真实券商状态与订单路由跑同一份策略代码。

   python my_strategy.py

   复制

5. 5运行测试

   用 pytest 跑全部测试或单个测试文件，验证本地环境与依赖是否正常。

   pytest

   复制

6. 6查看覆盖率

   可选：运行覆盖率统计并查看报告，确认测试覆盖情况。

   coverage run; coverage report

   复制

7. 7配置远程缓存

   可选：Lumibot 可把本地 parquet 缓存镜像到 AWS S3，具体参数见 docs/remote_cache.md。

关键配置

如何确认成功

回测命令无报错并输出回测结果；纸面模式下 Trader 正常启动并连接券商、日志显示策略在运行。

常见问题

注意事项

• README 未提供安装命令，安装方式请以官方文档为准，不要照搬第三方教程。
• 首次务必使用纸面交易（PAPER=true）验证，确认无误后再切换实盘。
• 测试可整体运行 pytest，也可只跑单个文件，如 pytest tests/test_asset.py。
• 涉及真实资金与密钥时请妥善保管 API Key，避免提交到代码仓库。