Skip to content

Commit bdccc47

Browse files
MDUYNMDUYN
committed
docs: refresh README feature SVGs (live-trading, marketplace, dashboard) + restore Finterion sponsor
- Add new feature SVGs: hero, vector/event backtest, live-trading, marketplace, dashboard (dark + light) - Embed official AWS, Azure logos in live-trading SVG - Embed Finterion logo in marketplace SVG; remove placeholder partner slots - Add 'Backtest Analysis & Dashboard' section showcasing built-in MCP server + notes keeping - Bold 'Backtesting Engines' section header to match other sections - Restore Finterion sponsor block at top of README - Update Live Trading copy: emphasize pluggable OrderExecutor alongside CCXT
1 parent 17f592f commit bdccc47

17 files changed

Lines changed: 3277 additions & 20 deletions

‎README.md‎

Lines changed: 135 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,11 @@
3838
</h4>
3939

4040
<p align="center">
41-
<img src="static/showcase.svg" alt="dashboard" style="max-width: 100%;">
41+
<picture>
42+
<source media="(prefers-color-scheme: dark)" srcset="static/features/hero-dark.svg">
43+
<source media="(prefers-color-scheme: light)" srcset="static/features/hero-light.svg">
44+
<img src="static/features/hero-dark.svg" alt="Investing Algorithm Framework — features overview" style="max-width: 100%;">
45+
</picture>
4246
</p>
4347

4448
<p align="center">
@@ -48,17 +52,9 @@
4852
</p>
4953

5054
<p align="center">
51-
<sub><b>Sponsored by</b></sub>
55+
<sub>Proudly sponsored by</sub>
5256
<br>
53-
<a href="https://www.finterion.com/" target="_blank">
54-
<picture>
55-
<source media="(prefers-color-scheme: dark)" srcset="static/sponsors/finterion-dark.png">
56-
<source media="(prefers-color-scheme: light)" srcset="static/sponsors/finterion-light.png">
57-
<img src="static/sponsors/finterion-light.png" alt="Finterion" width="200">
58-
</picture>
59-
</a>
60-
<br>
61-
<sub>Marketplace for trading bots</sub>
57+
<a href="https://www.finterion.com/" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="static/sponsors/finterion-dark.png"><source media="(prefers-color-scheme: light)" srcset="static/sponsors/finterion-light.png"><img src="static/sponsors/finterion-light.png" alt="Finterion" width="180"></picture></a>
6258
</p>
6359

6460
## Introduction
@@ -75,6 +71,7 @@ This framework is built around the full loop: **create strategies → vector bac
7571
</summary> <br>
7672

7773
- 📊 **30+ Metrics** — CAGR, Sharpe, Sortino, Calmar, VaR, CVaR, Max DD, Recovery & more
74+
- 🧮 **[Cross-Sectional Pipelines](https://coding-kitties.github.io/investing-algorithm-framework/Advanced%20Concepts/pipelines)** — Rank, filter and score entire universes of symbols every iteration with a tidy factor table
7875
- ⚡ **Vector Backtesting for Signal Analysis** — Quickly test your strategy logic on historical data to see how signals would have behaved before committing to full event-driven backtests
7976
- 🏃 **Event-Driven Backtesting** — Once promising strategies are identified via vector backtests, run full event-driven backtests to simulate realistic execution and portfolio management
8077
- 🔀 **Permutation Testing / Monte Carlo Simulations** — Assess the statistical robustness of your strategies by running them across randomized market scenarios to see how often your results could occur by chance
@@ -92,7 +89,109 @@ This framework is built around the full loop: **create strategies → vector bac
9289

9390
</details>
9491

95-
## Usage
92+
<details open>
93+
<summary>
94+
<strong>Backtesting Engines</strong>
95+
</summary> <br>
96+
97+
### ⚡ Vector Backtesting — Test thousands of strategies, fast
98+
99+
Polars-powered vectorized signal evaluation. Compare thousands of strategies side by side, sweep parameter grids, run multi-window robustness checks, rank by key metrics and surface your top candidates in seconds — all before committing to a full event-driven simulation.
100+
101+
<p align="center">
102+
<picture>
103+
<source media="(prefers-color-scheme: dark)" srcset="static/features/vector-backtest-dark.svg">
104+
<source media="(prefers-color-scheme: light)" srcset="static/features/vector-backtest-light.svg">
105+
<img src="static/features/vector-backtest-dark.svg" alt="Vector backtest engine — run thousands of strategies in parallel" style="max-width: 100%;">
106+
</picture>
107+
</p>
108+
109+
### 🏃 Event-Driven Backtesting — Bar-by-bar realism
110+
111+
Once you've narrowed down promising strategies, run them through a full event-driven simulation. Pluggable slippage and fill models, partial fills, and a complete simulation blotter — using the **same code path** you'll deploy live.
112+
113+
<p align="center">
114+
<picture>
115+
<source media="(prefers-color-scheme: dark)" srcset="static/features/event-backtest-dark.svg">
116+
<source media="(prefers-color-scheme: light)" srcset="static/features/event-backtest-light.svg">
117+
<img src="static/features/event-backtest-dark.svg" alt="Event-driven backtest engine — bar-by-bar realism with order fills" style="max-width: 100%;">
118+
</picture>
119+
</p>
120+
121+
</details>
122+
123+
<details open>
124+
<summary>
125+
<strong>Backtest Analysis & Dashboard</strong>
126+
</summary> <br>
127+
128+
Every backtest produces a **self-contained HTML dashboard** — open it in any browser, share with teammates, archive it. No server, no Jupyter, no dependencies. Compare strategies side-by-side, drill into trades, and capture your reasoning as you go.
129+
130+
<p align="center">
131+
<picture>
132+
<source media="(prefers-color-scheme: dark)" srcset="static/features/dashboard-dark.svg">
133+
<source media="(prefers-color-scheme: light)" srcset="static/features/dashboard-light.svg">
134+
<img src="static/features/dashboard-dark.svg" alt="Backtest analysis dashboard with MCP server and notes" style="max-width: 100%;">
135+
</picture>
136+
</p>
137+
138+
- **Self-contained HTML reports** — equity curves, drawdowns, trade lists, monthly returns, side-by-side strategy comparison
139+
- **Built-in MCP server** — let Copilot, Claude, or any MCP-compatible agent query your backtests, rank strategies, and reason over trades through `investing-algorithm-framework mcp`
140+
- **Notes keeping** — annotate every backtest with hypotheses, observations and conclusions; notes travel with the report so your research is never lost
141+
142+
→ [Backtest dashboard docs](https://coding-kitties.github.io/investing-algorithm-framework/Getting%20Started/backtesting) · [MCP server docs](https://coding-kitties.github.io/investing-algorithm-framework/Advanced%20Concepts/mcp-server)
143+
144+
</details>
145+
146+
<details open>
147+
<summary>
148+
<strong>Live Trading</strong>
149+
</summary> <br>
150+
151+
Once a strategy proves itself in backtests, deploy it with the **same code path** you backtested. Connect to any exchange — use the built-in [CCXT](https://github.com/ccxt/ccxt) integration, or plug in your own [`OrderExecutor`](https://coding-kitties.github.io/investing-algorithm-framework/Advanced%20Concepts/custom-order-executors) for brokers, FIX gateways, or any custom venue. Run locally, in Docker, or deploy serverless to **AWS Lambda** or **Azure Functions**. Built-in portfolio tracking, position management, order persistence, and automatic state recovery.
152+
153+
<p align="center">
154+
<picture>
155+
<source media="(prefers-color-scheme: dark)" srcset="static/features/live-trading-dark.svg">
156+
<source media="(prefers-color-scheme: light)" srcset="static/features/live-trading-light.svg">
157+
<img src="static/features/live-trading-dark.svg" alt="Live trading & deployment — AWS Lambda and Azure Functions" style="max-width: 100%;">
158+
</picture>
159+
</p>
160+
161+
- **No code rewrites** — your `TradingStrategy` runs identically in backtest, paper trading and live
162+
- **Cloud deploy** — `investing-algorithm-framework init --type aws_lambda` / `--type azure_function`
163+
- **Multiple exchanges & venues** — CCXT integration out of the box (Binance, Bitvavo, Coinbase, Kraken …), or plug in your own `OrderExecutor` for any broker / FIX / custom venue
164+
- **Portfolio persistence** — trades, orders and positions survive restarts
165+
166+
→ [Live trading & deployment docs](https://coding-kitties.github.io/investing-algorithm-framework/Getting%20Started/deployment)
167+
168+
</details>
169+
170+
<details open>
171+
<summary>
172+
<strong>Marketplace Integration</strong>
173+
</summary> <br>
174+
175+
Publish your winning strategies to the [**Finterion**](https://www.finterion.com/) marketplace and monetize them. Investors subscribe to your bot, you earn a recurring revenue share — the framework handles the technical integration.
176+
177+
<p align="center">
178+
<a href="https://www.finterion.com/" target="_blank">
179+
<picture>
180+
<source media="(prefers-color-scheme: dark)" srcset="static/features/marketplace-dark.svg">
181+
<source media="(prefers-color-scheme: light)" srcset="static/features/marketplace-light.svg">
182+
<img src="static/features/marketplace-dark.svg" alt="Marketplace integration — featuring Finterion" style="max-width: 100%;">
183+
</picture>
184+
</a>
185+
</p>
186+
187+
→ [Finterion plugin](https://github.com/Finterion/finterion-investing-algorithm-framework-plugin)
188+
189+
</details>
190+
191+
<details>
192+
<summary>
193+
<strong>Usage and Installation</strong>
194+
</summary> <br>
96195

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

@@ -242,6 +341,14 @@ Create as many strategy variants as you want — different parameters, different
242341

243342
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.
244343

344+
<p align="center">
345+
<picture>
346+
<source media="(prefers-color-scheme: dark)" srcset="static/features/dashboard-dark.svg">
347+
<source media="(prefers-color-scheme: light)" srcset="static/features/dashboard-light.svg">
348+
<img src="static/features/dashboard-dark.svg" alt="Self-contained HTML backtest dashboard" style="max-width: 100%;">
349+
</picture>
350+
</p>
351+
245352
```python
246353
from investing_algorithm_framework import BacktestReport
247354

@@ -277,6 +384,7 @@ report.save("my_report.html")
277384
| **[Backtest Report Dashboard](https://coding-kitties.github.io/investing-algorithm-framework/Getting%20Started/backtest-reports)** | Self-contained HTML report with ranking tables, equity curves, metric charts, heatmaps, and strategy comparison |
278385
| **[Event-Driven Backtesting](https://coding-kitties.github.io/investing-algorithm-framework/Getting%20Started/backtesting)** | Realistic, order-by-order simulation |
279386
| **[Vectorized Backtesting](https://coding-kitties.github.io/investing-algorithm-framework/Getting%20Started/vector-backtesting)** | Fast signal research and prototyping |
387+
| **[Cross-Sectional Pipelines](https://coding-kitties.github.io/investing-algorithm-framework/Advanced%20Concepts/pipelines)** | Compute factors across many symbols at once — rank, filter and score universes per iteration |
280388
| **50+ Metrics** | CAGR, Sharpe, Sortino, max drawdown, win rate, profit factor, recovery factor, volatility, and more |
281389
| **[Live Trading](https://coding-kitties.github.io/investing-algorithm-framework/Getting%20Started/application-setup)** | Connect to exchanges via CCXT for real-time execution |
282390
| **[Portfolio Management](https://coding-kitties.github.io/investing-algorithm-framework/Getting%20Started/portfolio-configuration)** | Position tracking, trade management, persistence |
@@ -289,14 +397,23 @@ report.save("my_report.html")
289397

290398
</details>
291399

292-
## Plugins
400+
</details>
401+
402+
<details>
403+
<summary>
404+
<strong>Plugins</strong>
405+
</summary> <br>
293406

294407
| Plugin | Description |
295408
|--------|-------------|
296409
| [PyIndicators](https://github.com/coding-kitties/PyIndicators) | Technical analysis indicators (EMA, RSI, MACD, etc.) |
297410
| [Finterion Plugin](https://github.com/Finterion/finterion-investing-algorithm-framework-plugin) | Share and monetize strategies on Finterion's marketplace |
298411

299-
## Development
412+
</details>
413+
414+
## Development & Contributing
415+
416+
We welcome contributions! Open an issue, pick one up, or send a PR.
300417

301418
```bash
302419
git clone https://github.com/coding-kitties/investing-algorithm-framework.git
@@ -307,19 +424,17 @@ poetry install
307424
python -m unittest discover -s tests
308425
```
309426

427+
- [Open an issue](https://github.com/coding-kitties/investing-algorithm-framework/issues/new) for bugs or ideas
428+
- Read the [Contributing Guide](https://coding-kitties.github.io/investing-algorithm-framework/Contributing%20Guide/contributing)
429+
- PRs go against the `dev` branch
430+
310431
## Resources
311432

312433
- **[Documentation](https://coding-kitties.github.io/investing-algorithm-framework/)** — Guides and API reference
313434
- **[Quick Start](https://coding-kitties.github.io/investing-algorithm-framework/Getting%20Started/installation)** — Get up and running
314435
- **[Discord](https://discord.gg/dQsRmGZP)** — Chat and support
315436
- **[Reddit](https://www.reddit.com/r/InvestingBots/)** — Strategy discussion
316437

317-
## Contributing
318-
319-
- [Open an issue](https://github.com/coding-kitties/investing-algorithm-framework/issues/new) for bugs or ideas
320-
- Read the [Contributing Guide](https://coding-kitties.github.io/investing-algorithm-framework/Contributing%20Guide/contributing)
321-
- PRs go against the `dev` branch
322-
323438
## Risk Disclaimer
324439

325440
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.

‎static/features/aws.svg‎

Lines changed: 38 additions & 0 deletions
Loading

‎static/features/azure.svg‎

Lines changed: 23 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)