cyqnt-trd 0.1.0__tar.gz

cyqnt_trd-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Haowen Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cyqnt_trd-0.1.0/MANIFEST.in

@@ -0,0 +1,20 @@
+# 包含必要的文件
+include README.md
+include LICENSE
+include requirements.txt
+include pyproject.toml
+include setup.py
+
+# 包含所有 Python 文件
+recursive-include cyqnt_trd *.py
+recursive-include cyqnt_trd *.md
+recursive-include cyqnt_trd *.txt
+
+# 排除不需要的文件
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude *$py.class
+global-exclude *.so
+global-exclude .DS_Store
+global-exclude *.egg-info
+

cyqnt_trd-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: cyqnt-trd
+Version: 0.1.0
+Summary: A cryptocurrency trading toolkit with data fetching, signal generation, and backtesting capabilities
+Author-email: Haowen Wang <wanghw@zju.edu.cn>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/whw199833/cyqnt_trd
+Project-URL: Repository, https://github.com/whw199833/cyqnt_trd
+Project-URL: Issues, https://github.com/whw199833/cyqnt_trd/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas>=1.5.0
+Requires-Dist: numpy>=1.23.0
+Requires-Dist: matplotlib>=3.5.0
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# cyqnt_trd
+
+一个用于加密货币交易的工具包，包含数据获取、交易信号生成和回测功能。
+
+## 功能特性
+
+- **数据获取**: 从 Binance 获取期货和现货K线数据
+- **交易信号**: 提供多种技术指标因子和信号策略
+- **回测框架**: 支持因子测试和策略回测
+
+## 安装
+
+### 方式1: 作为可编辑包安装（推荐用于开发）
+
+```bash
+cd /path/to/cyqnt_trd
+pip install -e .
+```
+
+### 方式2: 直接安装
+
+```bash
+cd /path/to/cyqnt_trd
+pip install .
+```
+
+### 方式3: 从源码安装
+
+```bash
+cd /path/to/cyqnt_trd
+python setup.py install
+```
+
+## 依赖
+
+主要依赖包：
+- pandas >= 1.5.0
+- numpy >= 1.23.0
+- matplotlib >= 3.5.0
+- requests >= 2.28.0
+
+Binance SDK 依赖（需要单独安装）：
+- binance-sdk-spot
+- binance-sdk-derivatives-trading-usds-futures
+- binance-sdk-algo
+- binance-common
+
+安装依赖：
+```bash
+pip install -r requirements.txt
+```
+
+## 使用方法
+
+### 作为 Python Package 使用
+
+安装后，可以直接导入使用：
+
+```python
+# 导入数据获取模块
+from cyqnt_trd.get_data import get_and_save_futures_klines, get_and_save_klines
+
+# 导入交易信号模块
+from cyqnt_trd.trading_signal.factor import ma_factor, rsi_factor
+from cyqnt_trd.trading_signal.signal import ma_signal, factor_based_signal
+
+# 导入回测框架
+from cyqnt_trd.backtesting import BacktestFramework, FactorTester, StrategyBacktester
+
+# 使用示例
+data = get_and_save_futures_klines("BTCUSDT", interval="1h", limit=100)
+framework = BacktestFramework(data_path="data/BTCUSDT_1h.json")
+result = framework.test_factor(ma_factor, short_window=5, long_window=20)
+```
+
+### 运行示例脚本
+
+```bash
+# 作为模块运行
+python -m cyqnt_trd.trading_signal.example_usage
+
+# 运行测试脚本
+python -m cyqnt_trd.test_script.realtime_price_tracker
+```
+
+## 项目结构
+
+```
+cyqnt_trd/
+├── cyqnt_trd/          # 主包目录
+│   ├── __init__.py         # 包初始化文件
+│   ├── get_data/           # 数据获取模块
+│   │   ├── __init__.py
+│   │   ├── get_futures_data.py
+│   │   └── get_trending_data.py
+│   ├── trading_signal/     # 交易信号模块
+│   │   ├── __init__.py
+│   │   ├── factor/         # 因子模块
+│   │   ├── signal/         # 信号策略模块
+│   │   └── selected_alpha/ # Alpha因子模块
+│   ├── backtesting/        # 回测框架
+│   │   ├── __init__.py
+│   │   ├── framework.py
+│   │   ├── factor_test.py
+│   │   └── strategy_backtest.py
+│   └── test_script/        # 测试脚本
+├── pyproject.toml          # 包配置文件
+├── requirements.txt        # 依赖列表
+└── README.md              # 说明文档
+```
+
+## 许可证
+
+MIT License
+
+Copyright (c) 2025 Haowen Wang

cyqnt_trd-0.1.0/README.md

@@ -0,0 +1,116 @@
+# cyqnt_trd
+
+一个用于加密货币交易的工具包，包含数据获取、交易信号生成和回测功能。
+
+## 功能特性
+
+- **数据获取**: 从 Binance 获取期货和现货K线数据
+- **交易信号**: 提供多种技术指标因子和信号策略
+- **回测框架**: 支持因子测试和策略回测
+
+## 安装
+
+### 方式1: 作为可编辑包安装（推荐用于开发）
+
+```bash
+cd /path/to/cyqnt_trd
+pip install -e .
+```
+
+### 方式2: 直接安装
+
+```bash
+cd /path/to/cyqnt_trd
+pip install .
+```
+
+### 方式3: 从源码安装
+
+```bash
+cd /path/to/cyqnt_trd
+python setup.py install
+```
+
+## 依赖
+
+主要依赖包：
+- pandas >= 1.5.0
+- numpy >= 1.23.0
+- matplotlib >= 3.5.0
+- requests >= 2.28.0
+
+Binance SDK 依赖（需要单独安装）：
+- binance-sdk-spot
+- binance-sdk-derivatives-trading-usds-futures
+- binance-sdk-algo
+- binance-common
+
+安装依赖：
+```bash
+pip install -r requirements.txt
+```
+
+## 使用方法
+
+### 作为 Python Package 使用
+
+安装后，可以直接导入使用：
+
+```python
+# 导入数据获取模块
+from cyqnt_trd.get_data import get_and_save_futures_klines, get_and_save_klines
+
+# 导入交易信号模块
+from cyqnt_trd.trading_signal.factor import ma_factor, rsi_factor
+from cyqnt_trd.trading_signal.signal import ma_signal, factor_based_signal
+
+# 导入回测框架
+from cyqnt_trd.backtesting import BacktestFramework, FactorTester, StrategyBacktester
+
+# 使用示例
+data = get_and_save_futures_klines("BTCUSDT", interval="1h", limit=100)
+framework = BacktestFramework(data_path="data/BTCUSDT_1h.json")
+result = framework.test_factor(ma_factor, short_window=5, long_window=20)
+```
+
+### 运行示例脚本
+
+```bash
+# 作为模块运行
+python -m cyqnt_trd.trading_signal.example_usage
+
+# 运行测试脚本
+python -m cyqnt_trd.test_script.realtime_price_tracker
+```
+
+## 项目结构
+
+```
+cyqnt_trd/
+├── cyqnt_trd/          # 主包目录
+│   ├── __init__.py         # 包初始化文件
+│   ├── get_data/           # 数据获取模块
+│   │   ├── __init__.py
+│   │   ├── get_futures_data.py
+│   │   └── get_trending_data.py
+│   ├── trading_signal/     # 交易信号模块
+│   │   ├── __init__.py
+│   │   ├── factor/         # 因子模块
+│   │   ├── signal/         # 信号策略模块
+│   │   └── selected_alpha/ # Alpha因子模块
+│   ├── backtesting/        # 回测框架
+│   │   ├── __init__.py
+│   │   ├── framework.py
+│   │   ├── factor_test.py
+│   │   └── strategy_backtest.py
+│   └── test_script/        # 测试脚本
+├── pyproject.toml          # 包配置文件
+├── requirements.txt        # 依赖列表
+└── README.md              # 说明文档
+```
+
+## 许可证
+
+MIT License
+
+Copyright (c) 2025 Haowen Wang

cyqnt_trd-0.1.0/cyqnt_trd/__init__.py

@@ -0,0 +1,26 @@
+"""
+Cyqnt Trading Package
+
+一个用于加密货币交易的工具包，包含数据获取、交易信号生成和回测功能。
+
+主要模块:
+- get_data: 数据获取模块，支持从 Binance 获取期货和现货数据
+- trading_signal: 交易信号模块，包含因子计算和信号策略
+- backtesting: 回测框架，支持因子测试和策略回测
+"""
+
+__version__ = "0.1.0"
+
+# 导入主要模块
+from . import get_data
+from . import trading_signal
+from . import backtesting
+
+__all__ = [
+    'get_data',
+    'trading_signal',
+    'backtesting',
+    'utils',
+    '__version__',
+]
+

cyqnt_trd-0.1.0/cyqnt_trd/backtesting/README.md

@@ -0,0 +1,264 @@
+# 回测框架使用说明
+
+本回测框架提供了两个主要功能：
+1. **单因子胜率测试** - 测试某个因子在预测未来价格方向上的胜率
+2. **策略回测** - 根据买卖信号进行回测，计算收益率和收益曲线
+
+## 功能概述
+
+### 1. 单因子胜率测试 (FactorTester)
+
+用于测试某个因子在预测未来一段时间内价格方向（多/空）的胜率。
+
+**主要功能：**
+- 计算因子值（正数=看多，负数=看空，0=中性）
+- 统计看多/看空信号的胜率
+- 计算平均收益率
+- 输出详细的测试结果
+
+### 2. 策略回测 (StrategyBacktester)
+
+根据买卖信号进行回测，计算收益率和收益曲线。
+
+**主要功能：**
+- 根据买卖信号模拟交易
+- 计算总收益率、胜率、最大回撤、夏普比率等指标
+- 绘制资金曲线、价格曲线和回撤曲线
+- 记录所有交易详情
+
+## 快速开始
+
+### 基本使用
+
+```python
+import pandas as pd
+import json
+from cyqnt_trd.backtesting import BacktestFramework
+
+# 加载数据
+data_path = 'path/to/your/data.json'
+framework = BacktestFramework(data_path=data_path)
+
+# 定义因子函数
+def my_factor(data: pd.DataFrame, index: int) -> float:
+    """因子函数：返回因子值（正数=看多，负数=看空）"""
+    current_price = data.iloc[index]['close_price']
+    # 你的因子计算逻辑
+    # ...
+    return 1.0  # 或 -1.0, 0.0
+
+# 测试因子
+results = framework.test_factor(
+    factor_func=my_factor,
+    forward_periods=7,  # 未来7个周期
+    min_periods=0,
+    factor_name="我的因子"
+)
+
+# 打印结果
+framework.print_factor_results(results)
+```
+
+### 策略回测
+
+```python
+# 定义信号函数
+def my_signal(data: pd.DataFrame, index: int) -> str:
+    """信号函数：返回 'buy', 'sell', 'hold' 或 None"""
+    # 你的信号生成逻辑
+    # ...
+    return 'buy'  # 或 'sell', 'hold'
+
+# 回测策略
+results = framework.backtest_strategy(
+    signal_func=my_signal,
+    min_periods=0,
+    position_size=0.5,  # 每次使用50%的资金
+    initial_capital=10000.0,
+    commission_rate=0.001  # 0.1%手续费
+)
+
+# 打印结果
+framework.print_backtest_results(results)
+
+# 绘制结果
+framework.plot_backtest_results(results)
+```
+
+## 数据格式要求
+
+数据可以是以下两种格式之一：
+
+### 1. JSON文件格式
+
+```json
+{
+  "symbol": "BTCUSDT",
+  "interval": "1m",
+  "data": [
+    {
+      "open_time": 1234567890000,
+      "open_time_str": "2023-01-01 00:00:00",
+      "open_price": 100.0,
+      "high_price": 105.0,
+      "low_price": 95.0,
+      "close_price": 102.0,
+      "volume": 1000.0,
+      ...
+    },
+    ...
+  ]
+}
+```
+
+### 2. DataFrame格式
+
+DataFrame必须包含以下列：
+- `datetime` 或 `open_time_str` 或 `open_time`: 时间
+- `close_price`: 收盘价
+- 其他因子计算所需的列（如 `open_price`, `high_price`, `low_price`, `volume` 等）
+
+## 详细示例
+
+### 示例1: 移动平均线因子测试
+
+```python
+def ma_factor(data: pd.DataFrame, index: int) -> float:
+    """MA5因子：价格高于MA5看多，低于MA5看空"""
+    if index < 5:
+        return 0
+    
+    current_price = data.iloc[index]['close_price']
+    ma5 = data.iloc[index-5:index]['close_price'].mean()
+    
+    if current_price > ma5:
+        return 1.0  # 看多
+    else:
+        return -1.0  # 看空
+
+# 测试因子
+framework = BacktestFramework(data_path='data.json')
+results = framework.test_factor(
+    factor_func=ma_factor,
+    forward_periods=7,
+    min_periods=5,
+    factor_name="MA5因子"
+)
+framework.print_factor_results(results)
+```
+
+### 示例2: 移动平均线交叉策略
+
+```python
+def ma_cross_signal(data: pd.DataFrame, index: int) -> str:
+    """MA交叉策略：价格上穿MA5买入，下穿MA5卖出"""
+    if index < 5:
+        return 'hold'
+    
+    current_price = data.iloc[index]['close_price']
+    ma5 = data.iloc[index-5:index]['close_price'].mean()
+    prev_price = data.iloc[index-1]['close_price']
+    prev_ma5 = data.iloc[index-6:index-1]['close_price'].mean()
+    
+    # 上穿
+    if prev_price <= prev_ma5 and current_price > ma5:
+        return 'buy'
+    # 下穿
+    elif prev_price >= prev_ma5 and current_price < ma5:
+        return 'sell'
+    else:
+        return 'hold'
+
+# 回测策略
+results = framework.backtest_strategy(
+    signal_func=ma_cross_signal,
+    min_periods=5,
+    position_size=0.5,
+    initial_capital=10000.0,
+    commission_rate=0.001
+)
+framework.plot_backtest_results(results)
+```
+
+## API参考
+
+### BacktestFramework
+
+主回测框架类，提供统一的接口。
+
+#### 方法
+
+- `test_factor(factor_func, forward_periods=7, min_periods=0, factor_name="factor")` - 测试因子胜率
+- `backtest_strategy(signal_func, min_periods=0, position_size=1.0, initial_capital=10000.0, commission_rate=0.001)` - 回测策略
+- `plot_backtest_results(results, figsize=(14, 10))` - 绘制回测结果
+- `print_factor_results(results)` - 打印因子测试结果
+- `print_backtest_results(results)` - 打印回测结果
+
+### FactorTester
+
+单因子胜率测试器。
+
+#### 方法
+
+- `test_factor(factor_func, forward_periods=7, min_periods=0, factor_name="factor")` - 测试因子
+- `print_results(results)` - 打印结果
+- `save_results(results, filepath)` - 保存结果到JSON文件
+
+### StrategyBacktester
+
+策略回测器。
+
+#### 方法
+
+- `backtest(signal_func, min_periods=0, position_size=1.0)` - 执行回测
+- `plot_results(results, figsize=(14, 10))` - 绘制结果
+- `print_results(results)` - 打印结果
+- `save_results(results, filepath)` - 保存结果到JSON文件
+
+## 注意事项
+
+1. **因子函数** (`factor_func`): 
+   - 接受 `(data: pd.DataFrame, index: int)` 作为参数
+   - 返回 `float`: 正数表示看多，负数表示看空，0表示中性
+
+2. **信号函数** (`signal_func`):
+   - 接受 `(data: pd.DataFrame, index: int)` 作为参数
+   - 返回 `str`: `'buy'`（买入）、`'sell'`（卖出）、`'hold'`（持有）或 `None`
+
+3. **数据要求**:
+   - 数据必须按时间排序
+   - 必须包含 `close_price` 列
+   - 必须包含时间列（`datetime`, `open_time_str` 或 `open_time`）
+
+4. **性能考虑**:
+   - 对于大量数据，建议使用适当的数据切片
+   - 因子和信号函数应该尽可能高效
+
+## 输出结果说明
+
+### 因子测试结果
+
+- `total_samples`: 总样本数
+- `long_signals`: 看多信号数量
+- `short_signals`: 看空信号数量
+- `long_win_rate`: 看多信号胜率
+- `short_win_rate`: 看空信号胜率
+- `overall_win_rate`: 总体胜率
+- `long_avg_return`: 看多信号平均收益率
+- `short_avg_return`: 看空信号平均收益率
+- `details`: 详细结果列表
+
+### 策略回测结果
+
+- `initial_capital`: 初始资金
+- `final_capital`: 最终资金
+- `total_return`: 总收益率
+- `total_trades`: 总交易次数
+- `win_trades`: 盈利交易次数
+- `loss_trades`: 亏损交易次数
+- `win_rate`: 胜率
+- `max_drawdown`: 最大回撤
+- `sharpe_ratio`: 夏普比率
+- `equity_curve`: 资金曲线（DataFrame）
+- `trades`: 交易记录列表
+

cyqnt_trd-0.1.0/cyqnt_trd/backtesting/__init__.py

@@ -0,0 +1,12 @@
+"""
+回测框架模块
+
+提供单因子胜率测试和策略回测功能
+"""
+
+from .factor_test import FactorTester
+from .strategy_backtest import StrategyBacktester
+from .framework import BacktestFramework
+
+__all__ = ['FactorTester', 'StrategyBacktester', 'BacktestFramework']
+