ThetaGang 项目使用教程

ThetaGang 项目使用教程

thetagangThetaGang is an IBKR bot for collecting money项目地址:https://gitcode.com/gh_mirrors/th/thetagang

1. 项目的目录结构及介绍

ThetaGang 项目的目录结构如下：

thetagang/
├── LICENSE
├── README.md
├── config
│   └── config.yaml
├── requirements.txt
├── setup.py
├── thetagang
│   ├── __init__.py
│   ├── main.py
│   └── utils.py
└── tests
    └── test_main.py

目录结构介绍

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• config: 配置文件目录。
  • config.yaml: 项目的配置文件。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。
• thetagang: 项目主代码目录。
  • __init__.py: 初始化文件。
  • main.py: 项目启动文件。
  • utils.py: 工具函数文件。
• tests: 测试代码目录。
  • test_main.py: 主代码的测试文件。

2. 项目的启动文件介绍

项目的启动文件是 thetagang/main.py。该文件包含了项目的主要逻辑和启动代码。以下是 main.py 的主要内容：

import os
from thetagang import config, utils

def main():
    # 读取配置文件
    config_path = os.path.join(os.path.dirname(__file__), '..', 'config', 'config.yaml')
    config_data = config.load_config(config_path)
    
    # 初始化工具函数
    utils.initialize(config_data)
    
    # 执行主要逻辑
    utils.run()

if __name__ == "__main__":
    main()

启动文件介绍

• main() 函数：项目的入口函数，负责读取配置文件、初始化工具函数并执行主要逻辑。
• config.load_config(config_path)：加载配置文件的函数。
• utils.initialize(config_data)：初始化工具函数的函数。
• utils.run()：执行主要逻辑的函数。

3. 项目的配置文件介绍

项目的配置文件是 config/config.yaml。该文件包含了项目的所有配置信息。以下是 config.yaml 的一个示例：

api_key: "your_api_key"
api_secret: "your_api_secret"
account_id: "your_account_id"
symbols:
  - SPY
  - TLT
options:
  expiration_days: 30
  strike_offset: 1

配置文件介绍

• api_key: API 密钥。
• api_secret: API 密钥的秘密。
• account_id: 账户 ID。
• symbols: 交易的股票符号列表。
• options: 选项配置。
  • expiration_days: 期权到期天数。
  • strike_offset: 期权行权价的偏移量。

以上是 ThetaGang 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

thetagangThetaGang is an IBKR bot for collecting money项目地址:https://gitcode.com/gh_mirrors/th/thetagang