# curiouslei/chanlun architecture

> Architecture diagram of the GitHub repository curiouslei/chanlun, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/curiouslei/chanlun
- Repository: https://github.com/curiouslei/chanlun

## Overview

##### Project type and purpose
- From the README ("缠论实现：K线合并、识别分型、计算笔、计算线段、计算中枢、识别买卖点") and the file tree, we see that this is a Python‐based technical analysis library and CLI tool for ChanLun theory. It ingests market data, processes K-lines, identifies fractals, strokes, segments and central pivots, and emits buy/sell signals. It also provides backtesting via the `cobra` submodule, hooks into MySQL for storage, and can push alerts via enterprise WeChat.

##### File structure
- Top-level:
- `main.py` – CLI entry point.
- `chanlun/` – core package.
- Subpackages in `chanlun/`:
- `data/` – adapters to fetch raw market data (`jq.py`, `ts.py`), base definitions, transfer logic.
- `cobra/` – backtest and parameter‐checking utilities for strategy validation.
- `config/` – configuration (e.g., `mysql_config.py`).
- `utils/` – generic helpers (DB connectors, caching, logging, plotting, JSON encoding, WeChat integration).
- Core modules: `analyze.py` (pipeline orchestration), `signals.py` (entry to signal logic), `objects.py` (domain models), `enums.py`.
- `task.py` – scheduled or batch task definitions.

##### Key insights from README
- ChanLun analysis stages and output of buy/sell signals.

## Diagram (Mermaid)

```mermaid
flowchart TD
    classDef data fill:#D0E6FF,stroke:#0366D6,color:#0366D6
    classDef core fill:#DFFFE0,stroke:#28A745,color:#28A745
    classDef util fill:#FFF5E1,stroke:#DAA520,color:#DAA520
    classDef external fill:#FFE0E0,stroke:#D73A49,color:#D73A49

    subgraph "CLI & Scheduler"
        direction TB
        MAIN["main.py"]:::core
        TASK["task.py"]:::core
    end
    click MAIN "https://github.com/curiouslei/chanlun/blob/main/main.py"
    click TASK "https://github.com/curiouslei/chanlun/blob/main/chanlun/task.py"

    MAIN -->|triggers| TASK
    TASK -->|invokes| DATA_LAYER
    MAIN -->|runs analysis| CORE_ENGINE

    subgraph "External Data Sources"
        direction TB
        JQ["JoinQuant API"]:::external
        TS["Tushare API"]:::external
    end
    click JQ "https://github.com/curiouslei/chanlun/blob/main/chanlun/data/jq.py"
    click TS "https://github.com/curiouslei/chanlun/blob/main/chanlun/data/ts.py"

    subgraph "Data Layer"
        direction TB
        DATAINIT["__init__.py"]:::data
        BASE["base.py"]:::data
        TRANSFER["data_transfer.py"]:::data
    end
    click DATAINIT "https://github.com/curiouslei/chanlun/blob/main/chanlun/data/__init__.py"
    click BASE "https://github.com/curiouslei/chanlun/blob/main/chanlun/data/base.py"
    click TRANSFER "https://github.com/curiouslei/chanlun/blob/main/chanlun/data/data_transfer.py"

    JQ -->|"raw bars"| DATAINIT
    TS -->|"raw bars"| DATAINIT
    DATAINIT --> BASE
    BASE --> TRANSFER
    TRANSFER -->|normalized bars| CORE_ANALYSIS

    subgraph "Configuration"
        direction TB
        MYSQL_CONF["mysql_config.py"]:::core
    end
    click MYSQL_CONF "https://github.com/curiouslei/chanlun/blob/main/chanlun/config/mysql_config.py"

    subgraph "Core Analysis Engine"
        direction TB
        ANALYZE["analyze.py"]:::core
        SIGNALS["signals.py"]:::core
        OBJECTS["objects.py"]:::core
        ENUMS["enums.py"]:::core
    end
    click ANALYZE "https://github.com/curiouslei/chanlun/blob/main/chanlun/analyze.py"
    click SIGNALS "https://github.com/curiouslei/chanlun/blob/main/chanlun/signals.py"
    click OBJECTS "https://github.com/curiouslei/chanlun/blob/main/chanlun/objects.py"
    click ENUMS "https://github.com/curiouslei/chanlun/blob/main/chanlun/enums.py"

    CORE_ENGINE[/Core Analysis/] 
    CORE_ENGINE --> ANALYZE
    ANALYZE --> SIGNALS
    SIGNALS --> OBJECTS
    SIGNALS --> ENUMS

    TRANSFER --> CORE_ENGINE
    CORE_ENGINE -->|signals| PERSISTENCE
    CORE_ENGINE -->|data| VISUALIZATION
    CORE_ENGINE -->|alerts| NOTIFICATION
    CORE_ENGINE -->|workflow| BACKTEST

    subgraph "Backtesting Engine (Cobra)"
        direction TB
        BACKTEST_UTIL["utils.py"]:::util
        BACKTEST_CHECK["check.py"]:::core
        BACKTEST_RUN["backtest.py"]:::core
    end
    click BACKTEST_UTIL "https://github.com/curiouslei/chanlun/blob/main/chanlun/cobra/utils.py"
    click BACKTEST_CHECK "https://github.com/curiouslei/chanlun/blob/main/chanlun/cobra/check.py"
    click BACKTEST_RUN "https://github.com/curiouslei/chanlun/blob/main/chanlun/cobra/backtest.py"

    BACKTEST --> BACKTEST_RUN
    BACKTEST_RUN --> ANALYZE
    BACKTEST_RUN --> SIGNALS

    subgraph "Persistence & Caching"
        direction TB
        DB_CONN["db_connector.py"]:::util
        MYSQL_CONN["MySqlConn.py"]:::util
        CACHE["cache.py"]:::util
        DB["MySQL Database"]:::external
    end
    click DB_CONN "https://github.com/curiouslei/chanlun/blob/main/chanlun/utils/db_connector.py"
    click MYSQL_CONN "https://github.com/curiouslei/chanlun/blob/main/chanlun/utils/MySqlConn.py"
    click CACHE "https://github.com/curiouslei/chanlun/blob/main/chanlun/utils/cache.py"

    PERSISTENCE --> DB_CONN
    DB_CONN --> MYSQL_CONN
    MYSQL_CONN --> DB
    CACHE --> CORE_ENGINE

    subgraph "Output & Visualization"
        direction TB
        ECHARTS["echarts_plot.py"]:::util
        JSONENC["jsonEncoder.py"]:::util
        IOUTIL["io.py"]:::util
    end
    click ECHARTS "https://github.com/curiouslei/chanlun/blob/main/chanlun/utils/echarts_plot.py"
    click JSONENC "https://github.com/curiouslei/chanlun/blob/main/chanlun/utils/jsonEncoder.py"
    click IOUTIL "https://github.com/curiouslei/chanlun/blob/main/chanlun/utils/io.py"

    VISUALIZATION --> ECHARTS
    VISUALIZATION --> JSONENC
    VISUALIZATION --> IOUTIL

    subgraph "Notification Service"
        direction TB
        QYWX["qywx.py"]:::util
    end
    click QYWX "https://github.com/curiouslei/chanlun/blob/main/chanlun/utils/qywx.py"

    NOTIFICATION --> QYWX

    class MAIN,TASK,DATAINIT,BASE,TRANSFER,MYSQL_CONF,ANALYZE,SIGNALS,OBJECTS,ENUMS,BACKTEST_UTIL,BACKTEST_CHECK,BACKTEST_RUN,DB_CONN,MYSQL_CONN,CACHE,ECHARTS,JSONENC,IOUTIL,QYWX core,util,data,external
```
