Update readme and add class inspection

Author: MDUYN

README.md

@@ -45,6 +45,38 @@ The Investing Algorithm Framework is a Python framework that enables swift and e
 - [ ] **AWS Lambda support (Planned)**: Stateless running for cloud function deployments in AWS.
 - [ ] **Azure App services support (Planned)**: deployments in Azure app services with Web UI.
 
+## Quickstart
+
+1. First install the framework using `pip`. The Investing Algorithm Framework is hosted on [PyPi](https://pypi.org/project/Blankly/).
+
+```bash
+$ pip install investing-algorithm-framework
+```
+
+2. Next, just run:
+
+```bash
+$ investing-algorithm-framewor init
+```
+
+or if you want the web version:
+
+```bash
+$ investing-algorithm-framework init --web
+```
+> You can always change the app to the web version by changing the `app.py` file.
+
+The command will create the file `app.py` and an example script called `strategy.py`.
+
+From there, you start building your trading bot in the `strategy.py`.
+
+More information can be found on our [docs](https://docs.blankly.finance)
+
+> Make sure you leave the `app.py` file as is, as it is the entry point for the framework.
+> You can change the `bot.py` file to your liking and add other files to the working directory.
+> The framework will automatically pick up the files in the working directory.
+```
+
 ## Example implementation
 
 The following algorithm connects to binance and buys BTC every 2 hours.
@@ -262,14 +294,6 @@ app.add_portfolio_configuration(
 We are continuously working on improving the performance of the framework. If
 you have any suggestions, please let us know.
 
-## How to install
-
-You can download the framework with pypi.
-
-```bash
-pip install investing-algorithm-framework
-```
-
 ## Installation for local development
 
 The framework is built with poetry. To install the framework for local development, you can run the following commands:

examples/backtest_example/run_backtest.py

@@ -4,10 +4,9 @@
 from datetime import datetime, timedelta
 
 
-from investing_algorithm_framework import CCXTOHLCVMarketDataSource, \
-    CCXTTickerMarketDataSource, PortfolioConfiguration, \
-    create_app, pretty_print_backtest, BacktestDateRange, TimeUnit, \
-    TradingStrategy, OrderSide, DEFAULT_LOGGING_CONFIG, Context
+from investing_algorithm_framework import (
+    CCXTOHLCVMarketDataSource, CCXTTickerMarketDataSource, PortfolioConfiguration, create_app, pretty_print_backtest, BacktestDateRange, TimeUnit, TradingStrategy, OrderSide, DEFAULT_LOGGING_CONFIG, Context
+)
 
 import tulipy as ti
 

investing_algorithm_framework/app/algorithm.py

@@ -22,7 +22,7 @@ class is responsible for managing the strategies and executing
     them in the correct order.
 
     Args:
-        name (str): The name of the algorithm
+        name (str): (Optional) The name of the algorithm
         description (str): The description of the algorithm
         context (dict): The context of the algorithm, for backtest
           references

investing_algorithm_framework/app/app.py

@@ -55,7 +55,7 @@ def __init__(self, state_handler=None, name=None):
         self._on_after_initialize_hooks = []
         self._state_handler = state_handler
         self._name = name
-        self._algorithm = Algorithm()
+        self._algorithm = Algorithm(name=self.name)
 
     @property
     def algorithm(self) -> Algorithm:
@@ -630,6 +630,8 @@ def run_backtest(
         output_directory=None,
         algorithm: Algorithm = None
     ) -> BacktestReport:
+        print(self.name)
+        print(self.algorithm.name)
         """
         Run a backtest for an algorithm. This method should be called when
         running a backtest.
@@ -696,8 +698,13 @@ def run_backtest(
                 config[RESOURCE_DIRECTORY], "backtest_reports"
             )
 
-        backtest_service.write_report_to_json(
-            report=report, output_directory=output_directory
+        # backtest_service.write_report_to_json(
+        #     report=report, output_directory=output_directory
+        # )
+        backtest_service.save_report(
+            report=report,
+            algorithm=self.algorithm,
+            output_directory=output_directory
         )
         return report
 
@@ -815,9 +822,14 @@ def run_backtests(
                         self.config[RESOURCE_DIRECTORY], "backtest_reports"
                     )
 
-                backtest_service.write_report_to_json(
-                    report=report, output_directory=output_directory
+                backtest_service.save_report(
+                    report=report,
+                    algorithm=algorithm,
+                    output_directory=output_directory
                 )
+                # backtest_service.write_report_to_json(
+                #     report=report, output_directory=output_directory
+                # )
                 reports.append(report)
 
         return reports

investing_algorithm_framework/services/backtesting/backtest_service.py

@@ -1,6 +1,7 @@
 from datetime import datetime, timedelta
 import re
 import os
+import inspect
 import json
 import pandas as pd
 from dateutil import parser
@@ -683,6 +684,84 @@ def _is_backtest_report(self, path: str) -> bool:
 
         return False
 
+    def save_report(
+        self,
+        report: BacktestReport,
+        algorithm,
+        output_directory: str
+    ) -> None:
+        output_directory = os.path.join(output_directory, algorithm.name)
+        collected_imports = set()
+        class_definitions = []
+        self.write_report_to_json(report, output_directory)
+
+        collected_imports = []
+        class_definitions = []
+
+        for strategy in algorithm.strategies:
+            cls = strategy.__class__
+            file_path = inspect.getfile(cls)
+
+            if os.path.exists(file_path):
+                with open(file_path, "r") as f:
+                    lines = f.readlines()
+
+                class_started = False
+                class_code = []
+                current_import = []
+
+                for line in lines:
+                    stripped_line = line.strip()
+
+                    # Start collecting an import line
+                    if stripped_line.startswith(("import ", "from ")):
+                        current_import.append(line.rstrip())
+
+                        # Handle single-line import directly
+                        if not stripped_line.endswith(("\\", "(")):
+                            collected_imports.append(" ".join(current_import))
+                            current_import = []
+
+                    # Continue collecting multi-line imports
+                    elif current_import:
+                        current_import.append(line.rstrip())
+
+                        # Stop when the multi-line import finishes
+                        if not stripped_line.endswith(("\\", ",")):
+                            collected_imports.append(" ".join(current_import))
+                            current_import = []
+
+                    # Catch any unfinished import (just in case)
+                    if current_import:
+                        collected_imports.append(" ".join(current_import))
+
+                    # Capture class definitions and functions
+                    if stripped_line.startswith("class ") or stripped_line.startswith("def "):
+                        class_started = True
+
+                    if class_started:
+                        class_code.append(line)
+
+                if class_code:
+                    class_definitions.append("".join(class_code))
+
+        filename = os.path.join(
+            output_directory,
+            f"algorithm.py"
+        )
+
+        # Save everything to a single file
+        with open(filename, "w") as f:
+            # Write unique imports at the top
+            for imp in collected_imports:
+                f.write(imp)
+
+            f.write("\n\n")
+
+            # Write class and function definitions
+            for class_def in class_definitions:
+                f.write(class_def + "\n\n")
+
     def write_report_to_json(
         self, report: BacktestReport, output_directory: str
     ) -> None: