stock-trek 0.2.3

Stock Trek time-series analysis
Documentation

stock-trek

A lightweight, composable time series and statistical toolkit designed for running crypto bots on stock-trek.com. Rust-native core with optional Python bindings

Overview

stock-trek provides core abstractions and utilities for working with market data, including:

  • Order books
  • Aligned/Rolling windows
  • Ticks
  • Statistical and analytical functions

Installation

Add to your Cargo.toml:

[dependencies]
stock-trek = "0.2.3"

Python Bindings

stock-trek also provides Python bindings which can be installed via

pip install stock-trek

Usage

Implement the StockTrekAlgorithm trait and register it with the annotation #[traitreg::register]:

use stock_trek::StockTrekAlgorithm;

pub struct MyAlgo {}

#[traitreg::register]
impl StockTrekAlgorithm for MyAlgo {
    fn create_signal(&self, context: StockTrekContext) -> StockTrekSignal {
      ...
    }
}

Stock-Trek verifies code before running it and disallows certain syntax elements. To verify code locally, install it with

cargo install stock-trek

then run the verify command with

stock-trek verify --file ./path/to/my/code/file.rs

Roadmap

Planned features include:

  • Technical indicators (EMA, RSI, MACD, etc.)
  • Backtesting and simulation utilities

Status

This project is in early development (0.x). APIs may change.

License

MIT