pyctp 使用教程

1. 项目目录结构及介绍

pyctp 的目录结构如下：

.
├── example       // 示例代码目录
│   ├── futures    // 期货示例代码
│   ├── futures2   // 另一个期货示例代码
│   ├── option     // 期权示例代码
│   ├── stock      // 股票示例代码
│   └── stock2     // 另一个股票示例代码
├── gitignore     // Git 忽略文件
├── LICENSE       // 开源许可证文件
├── README.md     // 项目读我文件
└── setup.py      // Python 包安装脚本

解释：

• example 目录包含了各种场景的示例代码，帮助用户了解如何使用 pyctp。
• gitignore 文件列出了版本控制应该忽略的文件类型。
• LICENSE 文件描述了项目的开源许可协议。
• README.md 提供了项目的基本信息和简介。
• setup.py 是用于构建和安装 pyctp 的 Python 脚本。

2. 项目的启动文件介绍

pyctp 并无特定的单一启动文件，因为它是一个库，而不是一个独立的应用程序。它的核心功能由 ApiStruct 和 MdApi, TraderApi 等类实现。这些类被设计为在用户的代码中导入并实例化以使用 CTP 接口。

例如，要使用期货版 API，您会在自己的代码中写入如下内容：

from ctp.futures import ApiStruct, MdApi, TraderApi

然后根据需要创建 MdApi 和 TraderApi 对象来连接服务器和进行数据交互。

3. 项目的配置文件介绍

pyctp 本身并不包含内置的配置文件，它依赖于 CTP 提供的 SDK 中的配置文件（如 MdConnect.cfg 和 TraderConnect.cfg）。这些文件通常包含连接参数，如服务器地址、端口号、前置机名等，需要用户根据实际情况填充或修改。

当使用 pyctp 时，你需要确保 CTP SDK 配置文件位于正确的位置，并且你的程序能够访问这些文件。通常，你可能需要在运行代码前设置环境变量，指向这些配置文件的路径。

export CTP_MD_CFG_PATH=/path/to/MdConnect.cfg
export CTP_TRADE_CFG_PATH=/path/to/TraderConnect.cfg

之后，MdApi 和 TraderApi 类会自动查找并使用这些配置文件中的设置建立连接。

请注意，具体配置文件的使用和参数设置应遵循 CTP 接口的官方文档和你对应的期货公司的要求。如果你是首次使用 CTP 接口，建议联系你的期货公司获取详细的配置指导和相关支持。