Skip to content

Installation

Neleus currently requires the Rust extension. The CLI and Python package sit on top of the neleus_core module built from crates/pybridge.

Requirements

  • Python 3.10+
  • Rust toolchain
  • maturin

Install From Source

python3 -m venv .venv
source .venv/bin/activate

pip install maturin
cd python
maturin develop --release
pip install -e .

Verify The Install

neleus about
neleus market search BTC

If the Rust extension is missing, Neleus will fail early on import. Build the pybridge first, then reinstall the Python package.

Documentation Site

This repository ships an MkDocs Material site under docs/.

Run it locally:

pip install -r docs/requirements.txt
mkdocs serve

Build static output:

mkdocs build