kingchenc
4aec5d544c
The 84 markdown files under docs/wiki/ are now published to the project's GitHub Wiki at https://github.com/kingchenc/wickra/wiki — a separate git repository (https://github.com/kingchenc/wickra.wiki.git) that GitHub hosts natively with its own UI, search and history. The flat layout that the GitHub Wiki requires has been generated, all internal cross-links rewritten, and a _Sidebar.md groups the 71 indicators by their canonical 8 families. Effects: - docs/wiki/ is removed from the main repo (-84 files). docs/README.md now just points readers at the Wiki. - PR template + CONTRIBUTING text updated to point at the Wiki instead of the in-repo path. The Wiki repo is separately cloneable and editable via the GitHub web UI. - examples/wasm/README.md cross-link fixed to use the Wiki URL. - The (still in-repo) CHANGELOG keeps its historical references to docs/wiki/ paths — those describe what the tree looked like at past releases and stay accurate as history. - README.md, license, all source unaffected. The Wiki itself ships with _Sidebar.md / _Footer.md generated from the 8-families taxonomy and 503/503 cross-links resolved.
Wickra examples
Runnable examples for every Wickra binding. Rust and Node examples live next
to the code they exercise so the language tooling (cargo run --example,
node) can find them; the Python examples have no crate of their own and
live here under python/.
Rust — examples/rust/
The Rust examples live in the wickra-examples workspace member crate.
| Example | What it does | Run |
|---|---|---|
streaming.rs |
Feed a synthetic price series through SMA / EMA / RSI / MACD tick by tick. | cargo run -p wickra-examples --bin streaming |
backtest.rs |
Compute a basket of indicators over an OHLCV CSV and print a summary. | cargo run -p wickra-examples --bin backtest -- <ohlcv.csv> |
multi_timeframe.rs |
Resample a 1-minute CSV via wickra-data and print indicators per timeframe. | cargo run -p wickra-examples --bin multi_timeframe |
parallel_assets.rs |
Serial vs BatchExt::batch_parallel (rayon) over a synthetic panel, with speedup. |
cargo run --release -p wickra-examples --bin parallel_assets -- --assets 200 --bars 5000 |
fetch_btcusdt.rs |
Download real BTCUSDT klines from the Binance REST API into examples/data/. |
cargo run -p wickra-examples --bin fetch_btcusdt |
live_binance.rs |
Stream live Binance klines through an indicator over a resilient WebSocket. | cargo run -p wickra-examples --bin live_binance |
Python — examples/python/
| Example | What it does | Run |
|---|---|---|
streaming.py |
Feed a synthetic price series through SMA / EMA / RSI / MACD tick by tick. | python -m examples.python.streaming |
backtest.py |
Basket of indicators over an OHLCV CSV. | python -m examples.python.backtest <ohlcv.csv> |
live_trading.py |
Live Binance feed → RSI / MACD / Bollinger → signals. | python -m examples.python.live_trading --symbol BTCUSDT --interval 1m |
multi_timeframe.py |
Resample a 1-minute CSV to coarser timeframes and compare. | python -m examples.python.multi_timeframe <1m.csv> |
parallel_assets.py |
Process many symbols in parallel — the Rust extension releases the GIL during batch computation. | python -m examples.python.parallel_assets --assets 200 --bars 5000 |
fetch_btcusdt.py |
Download real BTCUSDT klines from the Binance REST API into examples/data/ (urllib + stdlib only). |
python -m examples.python.fetch_btcusdt |
live_trading.py additionally needs pip install websockets.
Node.js — examples/node/
Build the native binding once, then link it into the examples directory:
cd bindings/node && npm install && npx napi build --platform --release
cd ../../examples/node && npm install # links wickra + installs `ws`
| Example | What it does | Run |
|---|---|---|
streaming.js |
Feed a synthetic price series through several indicators tick by tick. | node streaming.js |
backtest.js |
Basket of indicators over an OHLCV CSV; defaults to the bundled BTCUSDT daily dataset. | node backtest.js [ohlcv.csv] |
multi_timeframe.js |
Roll a 1-minute CSV up to 5m / 15m / 1h / 4h / 1d and print indicators per timeframe. | node multi_timeframe.js [path/to/1m.csv] |
parallel_assets.js |
Serial vs worker_threads pool over a synthetic panel, with speedup. |
node parallel_assets.js --assets 200 --bars 5000 |
live_trading.js |
Live Binance feed → RSI / MACD / Bollinger → signals. | node live_trading.js --symbol BTCUSDT --interval 1m |
fetch_btcusdt.js |
Download real BTCUSDT klines from the Binance REST API into examples/data/ (built-in fetch, Node 18+). |
node fetch_btcusdt.js |
WebAssembly — examples/wasm/
Build the WASM module first (one-time):
wasm-pack build bindings/wasm --target web --release --features panic-hook
Then serve the repository root (python -m http.server, npx http-server,
…) and open the demo you want in a browser.
| Example | What it does |
|---|---|
index.html |
Streams a synthetic price series through six indicators and draws a live <canvas> chart. |
backtest.html |
Streams a fetched OHLCV CSV through a basket of indicators (SMA, EMA, RSI, MACD, Bollinger, ATR, ADX, OBV) and prints a per-series summary table. |
live_trading.html |
Opens a browser-native WebSocket to Binance, runs RSI / MACD / Bollinger and flags BUY/SELL candidates. |
multi_timeframe.html |
Fetches a 1-minute CSV, rolls it up to 5m / 15m / 1h / 4h / 1d in-page, prints RSI / MACD hist / ADX per timeframe. |
parallel_assets.html |
Spawns a pool of module Workers (each loading its own copy of the WASM module) and reports the speedup over a serial baseline. |
Example datasets
examples/data/ holds seven real BTCUSDT OHLCV datasets, one
per timeframe (1m, 5m, 15m, 1h, 12h, 1d, 1month), in the standard
timestamp,open,high,low,close,volume layout. The Rust and Node backtest
examples and the indicator benchmarks run against them. Regenerate them with
the latest market history via cargo run -p wickra-examples --bin fetch_btcusdt.