Metadata-Version: 2.4
Name: neleus
Version: 0.1.13
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Dist: aiohttp>=3.9.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: typer>=0.9.0
Requires-Dist: rich>=13.0.0
Requires-Dist: toml>=0.10.2
Requires-Dist: numpy>=1.24.0
Requires-Dist: pytest>=7.0 ; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.21 ; extra == 'dev'
Requires-Dist: black>=23.0 ; extra == 'dev'
Requires-Dist: ruff>=0.1.0 ; extra == 'dev'
Requires-Dist: mypy>=1.5 ; extra == 'dev'
Requires-Dist: maturin>=1.0 ; extra == 'dev'
Provides-Extra: dev
Summary: Hyperliquid-first trading CLI and Python toolkit for terminal-first trading workflows
Keywords: trading,backtesting,crypto,quantitative,hyperliquid
Author: Neleus Team
License: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Documentation, https://auralshin.github.io/neleus/
Project-URL: Homepage, https://neleus.trade
Project-URL: Repository, https://github.com/auralshin/neleus

# Neleus

Neleus is a Hyperliquid-first CLI and Python toolkit backed by a Rust core.

It is built for terminal-first trading workflows:

- search Hyperliquid spot, perp, and HIP-3 markets
- run technical analysis and ranked market scans
- stream live order book data in the terminal
- scaffold Python strategy projects
- backtest strategies against Hyperliquid market data
- run strategies once or as a daemon with optional database-backed trade monitoring

## Links

- GitHub: [https://github.com/auralshin/neleus](https://github.com/auralshin/neleus)
- Documentation: [https://auralshin.github.io/neleus/](https://auralshin.github.io/neleus/)
- Website: [https://neleus.trade](https://neleus.trade)

## Install From Source

```bash
pip install maturin
maturin develop --release
pip install -e .
```

## CLI Examples

No-project market workflows:

```bash
neleus about
neleus market search GAS --scope all-perps
neleus market list --scope hip3 --dex xyz
neleus market analyze GAS --scope hip3 --dex flx
neleus market scan --scope perps
neleus market book flx:GAS-PERP
```

Project workflow:

```bash
neleus new my_strategy_project --db-backend postgres --trade-monitoring
cd my_strategy_project
neleus db init
neleus backtest --strategy momentum
neleus run --mode once --strategy momentum
```

## Python Strategy Workflow

Neleus scaffolds a Python project with:

- `neleus.toml` for market, runtime, and database settings
- a `strategies/` directory for strategy code
- runtime helpers like `run_project_once(...)` and `run_project_daemon(...)`
- a Rust bridge for market data, Hyperliquid adapters, and core trading types

For full usage guides, strategy examples, and configuration details, see the
hosted docs: [https://auralshin.github.io/neleus/](https://auralshin.github.io/neleus/)

