Skip to main content

A framework for creating trading bots

Project description

Investing Algorithm Framework

Create trading strategies. Compare them side by side. Pick the best one. 🚀

tests pypi downloads license
discord reddit stars

dashboard

Sponsored by
Finterion
Marketplace for trading bots

Introduction

Investing Algorithm Framework is a Python framework for creating, backtesting, and deploying trading strategies.

Most quant frameworks stop at "here's your backtest result." You get a number, maybe a chart, and then you're on your own figuring out which strategy is actually better.

This framework is built around the full loop: create strategies → backtest them → compare them in a single report → deploy the winner. It generates a self-contained HTML dashboard that lets you rank, filter, and visually compare every strategy you've tested — all in one view, no notebooks required.

Features
  • 📊 30+ Metrics — CAGR, Sharpe, Sortino, Calmar, VaR, CVaR, Max DD, Recovery & more
  • ⚔️ Multi-Strategy Comparison — Rank, filter & compare strategies in a single interactive report
  • 🪟 Multi-Window Robustness — Test across different time periods with window coverage analysis
  • 📈 Equity & Drawdown Charts — Overlay equity curves, rolling Sharpe, drawdown & return distributions
  • 🗓️ Monthly Heatmaps & Yearly Returns — Calendar heatmap per strategy with return/growth toggles
  • 🎯 Return Scenario Projections — Good, average, bad & very bad year projections from backtest data
  • 📉 Benchmark Comparison — Beat-rate analysis vs Buy & Hold, DCA, risk-free & custom benchmarks
  • 📄 One-Click HTML Report — Self-contained file, no server, dark & light theme, shareable
  • 🚀 Build → Backtest → Deploy — Local dev, cloud deploy (AWS / Azure), or monetize on Finterion

Usage

To get started, install the framework and scaffold a new project:

pip install investing-algorithm-framework

# Generate project structure
investing-algorithm-framework init

# Or for cloud deployment
investing-algorithm-framework init --type aws_lambda
investing-algorithm-framework init --type azure_function

The documentation provides guides and API reference. The quick start will walk you through your first strategy.

Creating a Strategy

The framework is designed around the TradingStrategy class. You define what data your strategy needs and when to buy or sell — the framework handles execution, position management, and reporting.

from investing_algorithm_framework import (
    TradingStrategy, TimeUnit, Context, OrderSide
)

class MyStrategy(TradingStrategy):
    time_unit = TimeUnit.HOUR
    interval = 2
    symbol_pairs = ["BTC/EUR"]

    def apply_strategy(self, context: Context, market_data):
        for pair in self.symbol_pairs:
            symbol = pair.split("/")[0]
            ohlcv = market_data[f"{pair}-ohlcv-2h"]
            price = ohlcv["Close"].iloc[-1]

            if self.should_buy(ohlcv) and not context.has_position(symbol):
                context.create_limit_order(
                    target_symbol=symbol,
                    order_side=OrderSide.BUY,
                    price=price,
                    percentage_of_portfolio=25,
                )

            if self.should_sell(ohlcv) and context.has_position(symbol):
                context.create_limit_order(
                    target_symbol=symbol,
                    order_side=OrderSide.SELL,
                    price=price,
                    percentage_of_portfolio=100,
                )

Create as many strategy variants as you want — different parameters, different indicators, different symbols — then backtest them all and compare in a single report.

Backtest Report Dashboard

Every backtest produces a single HTML file you can open in any browser, share with teammates, or archive. No server, no dependencies, no Jupyter required.

from investing_algorithm_framework import BacktestReport

# After running backtests
report = BacktestReport(backtest)
report.show()  # Opens dashboard in your browser

# Or load previously saved backtests from disk
report = BacktestReport.open(directory_path="path/to/backtests")
report.show()

# Compare multiple strategies side by side
report = BacktestReport.open(backtests=[backtest_a, backtest_b, backtest_c])
report.show()

# Save as a self-contained HTML file
report.save("my_report.html")

Overview page — KPI cards, key metrics ranking table, trading activity, return scenarios, equity curves, metric bar charts, monthly returns heatmap, return distributions, and window coverage matrix.

Strategy pages — Deep dive into each strategy with per-run equity curves, rolling Sharpe, drawdown, monthly/yearly returns, and portfolio summary.

Capabilities
Backtest Report Dashboard Self-contained HTML report with ranking tables, equity curves, metric charts, heatmaps, and strategy comparison
Event-Driven Backtesting Realistic, order-by-order simulation
Vectorized Backtesting Fast signal research and prototyping
50+ Metrics CAGR, Sharpe, Sortino, max drawdown, win rate, profit factor, recovery factor, volatility, and more
Live Trading Connect to exchanges via CCXT for real-time execution
Portfolio Management Position tracking, trade management, persistence
Cloud Deployment Deploy to AWS Lambda, Azure Functions, or run as a web service
Market Data OHLCV, tickers, custom data — Polars and Pandas native
Extensible Custom data providers, order executors, and strategy classes

Plugins

Plugin Description
PyIndicators Technical analysis indicators (EMA, RSI, MACD, etc.)
Finterion Plugin Share and monetize strategies on Finterion's marketplace

Development

git clone https://github.com/coding-kitties/investing-algorithm-framework.git
cd investing-algorithm-framework
poetry install

# Run all tests
python -m unittest discover -s tests

Resources

Contributing

Risk Disclaimer

If you use this framework for real trading, do not risk money you are afraid to lose. Test thoroughly with backtesting first. Start small. We assume no responsibility for your investment results.

Acknowledgements

We want to thank all contributors to this project. A full list can be found in AUTHORS.md.

Sponsor

Finterion

Finterion — Marketplace for trading bots. Monetize your strategies by publishing them on Finterion.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

investing_algorithm_framework-7.33.0.tar.gz (329.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

investing_algorithm_framework-7.33.0-py3-none-any.whl (442.1 kB view details)

Uploaded Python 3

File details

Details for the file investing_algorithm_framework-7.33.0.tar.gz.

File metadata

  • Download URL: investing_algorithm_framework-7.33.0.tar.gz
  • Upload date:
  • Size: 329.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.13 Linux/6.17.0-1010-azure

File hashes

Hashes for investing_algorithm_framework-7.33.0.tar.gz
Algorithm Hash digest
SHA256 a86351b15e63a82672ff0a232bb5042420849e8edcb1cccd27245af9378b8294
MD5 93061adea4bc81f0916d09bf7cbda844
BLAKE2b-256 73e41130e8473a59085e4e66481a674535c4633c06a44c31c5d33fe34d8ffbdd

See more details on using hashes here.

File details

Details for the file investing_algorithm_framework-7.33.0-py3-none-any.whl.

File metadata

File hashes

Hashes for investing_algorithm_framework-7.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6015af3ab1f3330b981c944c8961162d2926bc4e3eca92edf29ba55f9f911a2e
MD5 e0f0bc04a9e141a5b036f648cb802ca9
BLAKE2b-256 52d52861242ed10f75fb91761aec711379ba493d8c2dc55fb294c7e70ceeb92c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page