Metadata-Version: 2.4
Name: tradengin
Version: 0.1.0
Summary: Python bindings for the AlgoGators trade-ngin backtest engine
Author: AlgoGators
License-Expression: GPL-3.0-only
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Office/Business :: Financial :: Investment
Project-URL: Source, https://github.com/AlgoGators/trade-ngin
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# tradengin

Python bindings for the AlgoGators **trade-ngin** backtest engine.

```python
import tradengin
```

- `BacktestRunner` runs a backtest, either from a portfolio config tree plus the engine's
  database, or fully argument-driven from a `BacktestRunConfig` with no database.
- `MarketDataSource` is the base class for your own data provider (a DataFrame, a CSV, a vendor).
  Subclass it and return `Bar` objects from `load_bars()`.
- Strategies subclass `tradengin.BaseStrategy` in Python.

A run must say what its risk layer is: the engine has no default. Set `no_risk_reason`,
`no_risk_ruled_by` and `no_risk_ruled_on` on the `BacktestRunConfig` for a run with none.

See `examples/yfinance_backtest.py` in the source repository for a complete database-free run:
https://github.com/AlgoGators/trade-ngin

Licensed under the GNU General Public License v3.
