rustalib 0.3.0

Python wrapper for rustalib-core, a high-performance technical analysis library written in Rust.

rustalib

📈 High-performance technical indicators for trading, written in Rust and exposed to Python.
Designed for time series analysis, backtesting, and real-time execution.

---

🚀 Installation

🔧 For Python users (from PyPI)

If you just want to use the library in your Python projects:

pip install rustalib

This will install the precompiled Rust extension (wheels) published on PyPI.
Requires Python ≥ 3.8.

---

🛠️ For contributors or internal development

⚠️ The Rust core of this project is private.
You will not be able to build this project from source unless you have access to the Rust codebase.

If you are part of the internal team or have access to the Rust core, you can:

1. Make sure Rust and maturin are installed.
2. Clone the repo and install in development mode:

pip install maturin
maturin develop

To build a distributable wheel:

maturin build
pip install target/wheels/rustalib-*.whl

---

📋 Requirements

To run the example scripts, you need to install the Python dependencies listed in:

examples/requirements.txt

You can install them with:

pip install -r examples/requirements.txt

---

📁 Data source

All examples use SPY historical data downloaded via Yahoo Finance, saved to:

examples/data/SPY_1D.csv
examples/data/SPY_1D_2000_2024.csv

You can regenerate the CSV by running:

python examples/data/download_data.py

---

🧪 Example: Simple Moving Average (SMA)

Example file: examples/sma_example.py
Uses real SPY data from 2020 to 2024.

import pandas as pd
import numpy as np
from rustalib import SMA

df = pd.read_csv("examples/data/SPY_1D.csv")
close = df["Close"].to_numpy(dtype=np.float64)

sma = SMA(20)
df["SMA20"] = sma.calculate_all(close)
print(df.tail())

💡 This is just one of the available indicators. For more examples, check the /examples folder in the repository.

---

📦 Available indicators

Indicator	Description	Example File
EMA	Exponential Moving Average	ema_example.py
MACD	Moving Average Convergence Divergence	macd_example.py
SMA	Simple Moving Average	sma_example.py

Upcoming indicators: RSI, ATR, SuperTrend...

---

💡 Suggest new indicators

The Rust core is private and not open to external contributions.

If you’d like a new indicator to be included, open an issue in the rustalib repo with a clear description. Requests are welcome!

---

🧰 Features

• Backtest-friendly (calculate_all)
• Real-time streaming support (next)
• Ultra-fast thanks to Rust core
• Simple and consistent Python API

---

🪪 License

MIT © Cuantilab