diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..9538b6d --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,154 @@ +name: 构建发布 + +on: + push: + tags: + - 'v*' # 推送 tag 时触发发布 + workflow_dispatch: # 支持手动触发 + inputs: + publish-to-pypi: + description: '发布至 PyPI (true/false)' + required: false + default: 'false' + +env: + CARGO_TERM_COLOR: always + +jobs: + # ============================================================ + # Linux wheels (x86_64 + aarch64) + # ============================================================ + linux: + runs-on: ubuntu-latest + strategy: + matrix: + target: [x86_64, aarch64] + steps: + - uses: actions/checkout@v4 + + - name: 安装 Rust 工具链 + uses: dtolnay/rust-toolchain@stable + + - name: 构建 wheel + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.target }} + working-directory: chanlun-py + args: --release --out dist + manylinux: auto + before-script-linux: | + if [ "${{ matrix.target }}" = "aarch64" ]; then + sudo apt-get update && sudo apt-get install -y gcc-aarch64-linux-gnu + fi + + - name: 上传 wheel 产物 + uses: actions/upload-artifact@v4 + with: + name: wheels-linux-${{ matrix.target }} + path: chanlun-py/dist/ + + # ============================================================ + # macOS wheels (x86_64 + arm64) + # ============================================================ + macos: + runs-on: macos-latest + strategy: + matrix: + target: [x86_64, aarch64] + steps: + - uses: actions/checkout@v4 + + - name: 安装 Rust 工具链 + uses: dtolnay/rust-toolchain@stable + + - name: 构建 wheel + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.target }} + working-directory: chanlun-py + args: --release --out dist + + - name: 上传 wheel 产物 + uses: actions/upload-artifact@v4 + with: + name: wheels-macos-${{ matrix.target }} + path: chanlun-py/dist/ + + # ============================================================ + # Windows wheels (x86_64) + # ============================================================ + windows: + runs-on: windows-latest + strategy: + matrix: + target: [x64] + steps: + - uses: actions/checkout@v4 + + - name: 安装 Rust 工具链 + uses: dtolnay/rust-toolchain@stable + + - name: 构建 wheel + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.target }} + working-directory: chanlun-py + args: --release --out dist + + - name: 上传 wheel 产物 + uses: actions/upload-artifact@v4 + with: + name: wheels-windows-${{ matrix.target }} + path: chanlun-py/dist/ + + # ============================================================ + # 源码分发包 (sdist) + # ============================================================ + sdist: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: 构建 sdist + uses: PyO3/maturin-action@v1 + with: + command: sdist + working-directory: chanlun-py + args: --out dist + + - name: 上传 sdist 产物 + uses: actions/upload-artifact@v4 + with: + name: wheels-sdist + path: chanlun-py/dist/ + + # ============================================================ + # 发布至 PyPI + # ============================================================ + publish: + needs: [linux, macos, windows, sdist] + runs-on: ubuntu-latest + if: startsWith(github.ref, 'refs/tags/v') || github.event.inputs.publish-to-pypi == 'true' + permissions: + id-token: write # PyPI 信任发布(推荐) + + steps: + - name: 下载所有产物 + uses: actions/download-artifact@v4 + with: + path: dist/ + pattern: wheels-* + merge-multiple: true + + - name: 列出产物 + run: ls -la dist/ + + - name: 发布至 PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + with: + packages-dir: dist/ + # 使用 OIDC 信任发布(推荐),无需配置 token + # 若使用 API token,在 GitHub Secrets 中设置: + # PYPI_TOKEN: pypi-xxxxxxxxxxxx + # 然后将下一行改为: + # password: ${{ secrets.PYPI_TOKEN }} diff --git a/README.md b/README.md index c8b4210..249a2bd 100644 --- a/README.md +++ b/README.md @@ -1 +1,78 @@ -# chanlun.rs \ No newline at end of file +# chanlun — 缠论技术分析 Python 绑定 + +[![PyPI](https://img.shields.io/pypi/v/chanlun)](https://pypi.org/project/chanlun/) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) + +基于 [chanlun](../chanlun/) Rust 核心库的 PyO3 高性能 Python 绑定,API 与 `chan.py` 完全兼容。 + +## 安装 + +```bash +pip install chanlun +``` + +## 快速开始 + +```python +import chanlun + +# 创建配置(全部默认值) +config = chanlun.缠论配置() + +# 读取 K 线数据文件,创建观察者 +obs = chanlun.观察者.读取数据文件("path/to/data.nb", config) + +# 查看各层级序列 +print(f"K线数量: {len(obs.普通K线序列)}") +print(f"笔数量: {len(obs.笔序列)}") +print(f"线段数量: {len(obs.线段序列)}") +print(f"中枢数量: {len(obs.中枢序列)}") + +# 或使用立体分析器进行多周期分析 +analyzer = chanlun.立体分析器("BTCUSD", ["1min", "5min", "30min"], config) +# 逐根投喂 K 线... +``` + +## 从源码构建 + +前置依赖: [Rust](https://www.rust-lang.org) + [maturin](https://www.maturin.rs) + +```bash +pip install maturin + +# 开发模式(直接安装到当前 venv) +maturin develop + +# 或构建 wheel +maturin build --release +pip install target/wheels/chanlun-*.whl +``` + +也可使用项目内的 `build.sh`: + +```bash +./build.sh develop # 开发安装 +./build.sh wheel # 构建 wheel +./build.sh test # 运行集成测试 +``` + +## 导出类 + +| 类别 | 类名 | 说明 | +|------|------|------| +| 枚举 | `买卖点类型`, `相对方向`, `分型结构` | 缠论基础枚举 | +| 数据 | `缺口`, `K线`, `缠论K线` | K 线数据结构 | +| 结构 | `分型`, `虚线`, `线段特征`, `特征分型` | 分析层级结构 | +| 指标 | `平滑异同移动平均线`, `相对强弱指数`, `随机指标` | MACD/RSI/KDJ | +| 算法 | `笔`, `线段`, `中枢`, `背驰分析` | 识别算法 | +| 业务 | `缠论配置`, `基础买卖点`, `买卖点`, `观察者`, `K线合成器`, `立体分析器` | 分析框架 | + +## 兼容性 + +- Python 3.9+ +- 类名 / 方法名 / 字段名 / 签名与 `chan.py` 一致 +- 支持 `.nb` / `.dat` 二进制文件格式(大端字节序) + +## 许可 + +MIT diff --git a/chanlun-py/Cargo.toml b/chanlun-py/Cargo.toml index 349be71..196bc4a 100644 --- a/chanlun-py/Cargo.toml +++ b/chanlun-py/Cargo.toml @@ -14,7 +14,7 @@ name = "chanlun" [dependencies] # 发布至 PyPI 前,需先将 chanlun 发布至 crates.io,然后替换为版本号依赖: # chanlun = "0.1" -chanlun = { path = "../chanlun" } +chanlun = "25.5.1" # { path = "../chanlun" } pyo3 = { version = "0.28", features = ["extension-module"] } serde_json = "1" chrono = "0.4" diff --git a/chanlun/Cargo.toml b/chanlun/Cargo.toml index a92d7f5..620eeca 100644 --- a/chanlun/Cargo.toml +++ b/chanlun/Cargo.toml @@ -9,6 +9,9 @@ readme = "README.md" repository = "https://github.com/YuYuKunKun/chanlun.rs" keywords = ["trading", "finance", "technical-analysis", "quant", "chanlun"] categories = ["algorithms", "finance", "science"] +homepage = "https://github.com/YuYuKunKun/chanlun.rs" +documentation = "https://docs.rs/chanlun/" +authors = ["YuYuKunKun"] [dependencies] serde = { version = "1", features = ["derive"] }