investing-algorithm-framework 3.5.2__tar.gz → 3.7.0__tar.gz

{investing_algorithm_framework-3.5.2 → investing_algorithm_framework-3.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: investing-algorithm-framework
-Version: 3.5.2
+Version: 3.7.0
 Summary: A framework for creating trading bots
 Author: MDUYN
 Requires-Python: >=3.8.1,<4.0.0
@@ -10,13 +10,15 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: Flask (>=2.3.2,<3.0.0)
-Requires-Dist: Flask-Cors (>=3.0.9,<4.0.0)
+Requires-Dist: Flask-Cors (>=3.0.9,<5.0.0)
 Requires-Dist: Flask-Migrate (>=2.6.0,<3.0.0)
 Requires-Dist: MarkupSafe (>=2.1.2,<3.0.0)
 Requires-Dist: SQLAlchemy (>=2.0.18,<3.0.0)
 Requires-Dist: ccxt (>=4.2.48,<5.0.0)
 Requires-Dist: dependency-injector (>=4.40.0,<5.0.0)
+Requires-Dist: jupyter (>=1.0.0,<2.0.0)
 Requires-Dist: marshmallow (>=3.5.0,<4.0.0)
+Requires-Dist: plotly (>=5.22.0,<6.0.0)
 Requires-Dist: polars[numpy,pandas] (>=0.20.10,<0.21.0)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: schedule (>=1.1.0,<2.0.0)
@@ -48,11 +50,12 @@ components for creating algorithms, including data provisioning,
 portfolio management, and order execution.
 
 Features: 
-* Order execution
+* Order execution and tracking
 * Broker and exchange connections through [ccxt](https://github.com/ccxt/ccxt)
-* Backtesting and performance analysis reports [example](./examples/backtest)
-* Backtest experiments to optimize your trading strategy [example](./examples/backtest_experiment)
-* Portfolio management
+* Backtesting and performance analysis reports [example](./examples/backtest_example)
+* Backtesting multiple algorithms with different backtest date ranges [example](./examples/backtests_example)
+* Portfolio management and tracking
+* Tracing for analyzing and debugging your trading bot
 * Web API for interacting with your deployed trading bot
 * Data persistence through sqlite db or an in-memory db
 * Stateless running for cloud function deployments
@@ -95,9 +98,6 @@ bitvavo_btc_eur_ticker = CCXTTickerMarketDataSource(
 )
 app = create_app(config=config)
 algorithm = Algorithm()
-
-app.add_market_data_source(bitvavo_btc_eur_ohlcv_2h)
-app.add_market_data_source(bitvavo_btc_eur_ticker)
 app.add_market_credential(MarketCredential(
     market="bitvavo",
     api_key="<your api key>",
@@ -117,7 +117,7 @@ app.add_algorithm(algorithm)
     time_unit=TimeUnit.HOUR, 
     interval=2, 
     # Specify market data sources that need to be passed to the strategy
-    market_data_sources=["BTC-ticker", "BTC-ohlcv"]
+    market_data_sources=[bitvavo_btc_eur_ticker, bitvavo_btc_eur_ohlcv_2h]
 )
 def perform_strategy(algorithm: Algorithm, market_data: dict):
     # By default, ohlcv data is passed as polars df in the form of
@@ -167,64 +167,82 @@ you will get the following backtesting report:
  
 ```bash
 
-                          /&#                                      #&(                 Backtest report
-                          &&&&&&&&&&&#                       &&&&&&&&&&&&              ---------------------------
-                         &&&&&&&&&&&&&&&&                (&&&&&&&&&&&&&&&              Start date: 2023-08-24 00:00:00
-                         &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&              End date: 2023-12-02 00:00:00
-                         &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&              Number of days: 100 
-                          &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&              Number of runs: 1201
-                          .&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&               Number of orders: 10
-                           &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.               Initial balance: 400.0
-                          &&&&&&&#  /(((   &&&&&&&&&&&&*(((     .&&&&&&&.              Final balance: 431.1499      
-              &&&&&&&&&&&&&&&&&&&    ((((    &&&&&&&&   ((((     &&&&&&&&&&&&&&&&&&&   Total net gain: 28.5542 7.139%  
-                       (((&&&&&&&&    ((((    &&&&&&     ((((   &&&&&&&&&((            Growth: 31.1499 7.787%             
-               /((((((((((&&&&&&&&&&   (((,   &&&&&&      (((**&&&&&&&&&(((((((((((    Number of trades closed: 4
-                     &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&          Number of trades open(end of backtest): 2
-                            &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&                 Percentage positive trades: 60.0%
-                              &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&                   Percentage negative trades: 20.0%
-                     (((((      &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&(                      Average trade size: 98.9886 EUR
-                    (((((           &&&&&&&&&&&&&&&&&&&&&&&&,                          Average trade duration: 184.0 hours
-                   (((((                 &&&&&&&&&&&&&#                            
-                  (((((                  #&&&&&&&&&&###                            
-                 (((((                   &&&&&&&&&&&###.                           
-               .(((((                   &&&&&&&&&&&&&&###(                          
-              (((((                   &&&&&&&&&&&&&&&&#(((/                        
-             (((((                  &&&&&&&&&&&&&&&&&&&@((((                       
-            (((((                  &&&&&&&&&&&&&&&&&&&&&&((((                      
-           (((((                  &&&&&&&&&&&&&&&&&&&&&&&&((((,                    
-         .(((((                   &&&&&&&&&&&&&&&&&&&&&&&&&&((((                    
-        (((((                   &&&&&&&&&&&&&&&&&&&&&&&&&&&&((((                   
-       (((((                    &&&&&&&&&&&&&&&&&&&&&&&&&&&&&((((                  
-      (((((                    &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&((((                  
-     (((((                     &&&&&&&&&&&&&&&&&&&&&&&&&&&&&#((((                  
-     (((((((((((((((((((#########&&&&&&&&&&&&&&&&&&&&&&&&&&&&(((((                  
-      (((((((((((((((((((((######&&&&&&&&&&&&&&&&&&&&&&&&&&&&((((                   
+                  :%%%#+-          .=*#%%%        Backtest report
+                  *%%%%%%%+------=*%%%%%%%-       ---------------------------
+                  *%%%%%%%%%%%%%%%%%%%%%%%-       Start date: 2023-08-24 00:00:00
+                  .%%%%%%%%%%%%%%%%%%%%%%#        End date: 2023-12-02 00:00:00
+                   #%%%####%%%%%%%%**#%%%+        Number of days: 100 
+             .:-+*%%%%- -+..#%%%+.+-  +%%%#*=-:   Number of runs: 1201
+              .:-=*%%%%. += .%%#  -+.-%%%%=-:..   Number of orders: 40
+              .:=+#%%%%%*###%%%%#*+#%%%%%%*+-:    Initial balance: 400.0
+                    +%%%%%%%%%%%%%%%%%%%=         Final balance: 428.2434
+                :++  .=#%%%%%%%%%%%%%*-           Total net gain: 28.2434 7.061%
+               :++:      :+%%%%%%#-.              Growth: 28.2434 7.061%
+              :++:        .%%%%%#=                Number of trades closed: 20
+             :++:        .#%%%%%#*=               Number of trades open(end of backtest): 0
+            :++-        :%%%%%%%%%+=              Percentage positive trades: 30.0%
+           .++-        -%%%%%%%%%%%+=             Percentage negative trades: 70.0%
+          .++-        .%%%%%%%%%%%%%+=            Average trade size: 100.9692 EUR
+         .++-         *%%%%%%%%%%%%%*+:           Average trade duration: 83.6 hours
+        .++-          %%%%%%%%%%%%%%#+=         
+        =++........:::%%%%%%%%%%%%%%*+-         
+        .=++++++++++**#%%%%%%%%%%%%%++.         
         
+Price noise
+
 Positions overview
 ╭────────────┬──────────┬──────────────────────┬───────────────────────┬──────────────┬───────────────┬───────────────────────────┬────────────────┬───────────────╮
 │ Position   │   Amount │   Pending buy amount │   Pending sell amount │   Cost (EUR) │   Value (EUR) │ Percentage of portfolio   │   Growth (EUR) │ Growth_rate   │
 ├────────────┼──────────┼──────────────────────┼───────────────────────┼──────────────┼───────────────┼───────────────────────────┼────────────────┼───────────────┤
-│ EUR        │ 217.044  │                    0 │                     0 │      217.044 │       217.044 │ 50.3407%                  │         0      │ 0.0000%       │
+│ EUR        │  428.243 │                    0 │                     0 │      428.243 │       428.243 │ 100.0000%                 │              0 │ 0.0000%       │
 ├────────────┼──────────┼──────────────────────┼───────────────────────┼──────────────┼───────────────┼───────────────────────────┼────────────────┼───────────────┤
-│ BTC        │   0.003  │                    0 │                     0 │      104.372 │       106.84  │ 24.7802%                  │         2.4678 │ 2.3644%       │
+│ DOT        │    0     │                    0 │                     0 │        0     │         0     │ 0.0000%                   │              0 │ 0.0000%       │
 ├────────────┼──────────┼──────────────────────┼───────────────────────┼──────────────┼───────────────┼───────────────────────────┼────────────────┼───────────────┤
-│ DOT        │  21.3295 │                    0 │                     0 │      107.138 │       107.266 │ 24.8791%                  │         0.128  │ 0.1195%       │
+│ BTC        │    0     │                    0 │                     0 │        0     │         0     │ 0.0000%                   │              0 │ 0.0000%       │
 ╰────────────┴──────────┴──────────────────────┴───────────────────────┴──────────────┴───────────────┴───────────────────────────┴────────────────┴───────────────╯
 Trades overview
 ╭─────────┬─────────────────────┬─────────────────────┬────────────────────┬──────────────┬──────────────────┬───────────────────────┬────────────────────┬─────────────────────╮
 │ Pair    │ Open date           │ Close date          │   Duration (hours) │   Size (EUR) │   Net gain (EUR) │ Net gain percentage   │   Open price (EUR) │   Close price (EUR) │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ DOT-EUR │ 2023-11-30 18:00:00 │                     │            3207.26 │     107.138  │           0      │ 0.0000%               │             5.023  │                     │
+│ DOT-EUR │ 2023-11-24 12:00:00 │ 2023-11-27 14:00:00 │                 74 │     107.55   │          -1.9587 │ -1.8212%              │             4.777  │              4.69   │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-11-20 00:00:00 │ 2023-11-21 08:00:00 │                 32 │     109.39   │          -4.5949 │ -4.2005%              │             4.9875 │              4.778  │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-11-19 22:00:00 │ 2023-11-22 00:00:00 │                 50 │     109.309  │          -2.7624 │ -2.5272%              │         34159.1    │          33295.9    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-11-06 12:00:00 │ 2023-11-13 14:00:00 │                170 │     107.864  │           6.1015 │ 5.6567%               │         32685.9    │          34534.9    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-10-20 12:00:00 │ 2023-10-27 08:00:00 │                164 │      99.085  │          10.9799 │ 11.0813%              │             3.5465 │              3.9395 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-10-14 04:00:00 │ 2023-10-27 22:00:00 │                330 │      97.4278 │          24.137  │ 24.7742%              │         25638.9    │          31990.7    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-10-14 04:00:00 │ 2023-10-17 14:00:00 │                 82 │      99.5572 │          -1.8877 │ -1.8961%              │             3.56   │              3.4925 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-10-07 08:00:00 │ 2023-10-08 08:00:00 │                 24 │      99.9498 │          -1.5708 │ -1.5716%              │             3.8815 │              3.8205 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-09-27 10:00:00 │ 2023-10-05 20:00:00 │                202 │      98.2888 │           3.433  │ 3.4927%               │         25202.2    │          26082.5    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-27 10:00:00 │ 2023-10-03 20:00:00 │                154 │      98.7893 │           1.2085 │ 1.2233%               │             3.842  │              3.889  │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-25 12:00:00 │ 2023-09-27 04:00:00 │                 40 │      98.9193 │          -0.5194 │ -0.5251%              │             3.809  │              3.789  │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-14 16:00:00 │ 2023-09-18 02:00:00 │                 82 │      98.9419 │          -0.0912 │ -0.0921%              │             3.799  │              3.7955 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-09-07 06:00:00 │ 2023-09-10 16:00:00 │                 82 │      98.6093 │           0.3412 │ 0.3460%               │         24051      │          24134.3    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-07 00:00:00 │ 2023-09-09 02:00:00 │                 50 │      98.9158 │          -0.2358 │ -0.2383%              │             3.986  │              3.9765 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-05 14:00:00 │ 2023-09-06 12:00:00 │                 22 │      99.2132 │          -1.1909 │ -1.2003%              │             3.999  │              3.951  │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ BTC-EUR │ 2023-11-29 12:00:00 │                     │            3237.26 │     104.372  │           0      │ 0.0000%               │         34790.7    │                     │
+│ DOT-EUR │ 2023-09-04 16:00:00 │ 2023-09-04 22:00:00 │                  6 │      99.355  │          -0.5671 │ -0.5708%              │             3.942  │              3.9195 │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ BTC-EUR │ 2023-11-07 22:00:00 │ 2023-11-14 14:00:00 │             160    │      99.2337 │           2.5395 │ 2.5591%               │         33077.9    │          33924.4    │
+│ DOT-EUR │ 2023-09-04 10:00:00 │ 2023-09-04 14:00:00 │                  4 │      99.4774 │          -0.4889 │ -0.4914%              │             3.968  │              3.9485 │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ BTC-EUR │ 2023-11-06 14:00:00 │ 2023-11-06 18:00:00 │               4    │      98.2854 │          -0.4248 │ -0.4322%              │         32761.8    │          32620.2    │
+│ BTC-EUR │ 2023-08-26 10:00:00 │ 2023-08-26 18:00:00 │                  8 │      99.0829 │          -0.03   │ -0.0302%              │         24166.6    │          24159.3    │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ DOT-EUR │ 2023-10-30 04:00:00 │ 2023-11-14 00:00:00 │             356    │     100.537  │          24.2886 │ 24.1588%              │             4.0565 │              5.0365 │
+│ DOT-EUR │ 2023-08-25 10:00:00 │ 2023-08-28 10:00:00 │                 72 │      99.659  │          -0.6975 │ -0.6999%              │             4.1435 │              4.1145 │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ BTC-EUR │ 2023-09-13 14:00:00 │ 2023-09-22 14:00:00 │             216    │      97.8976 │           2.1508 │ 2.1970%               │         24474.4    │          25012.1    │
+│ DOT-EUR │ 2023-08-24 00:00:00 │ 2023-08-25 00:00:00 │                 24 │      99.9999 │          -1.3626 │ -1.3626%              │             4.1465 │              4.09   │
 ╰─────────┴─────────────────────┴─────────────────────┴────────────────────┴──────────────┴──────────────────┴───────────────────────┴────────────────────┴─────────────────────╯
 ```
 

{investing_algorithm_framework-3.5.2 → investing_algorithm_framework-3.7.0}/README.md

@@ -21,11 +21,12 @@ components for creating algorithms, including data provisioning,
 portfolio management, and order execution.
 
 Features: 
-* Order execution
+* Order execution and tracking
 * Broker and exchange connections through [ccxt](https://github.com/ccxt/ccxt)
-* Backtesting and performance analysis reports [example](./examples/backtest)
-* Backtest experiments to optimize your trading strategy [example](./examples/backtest_experiment)
-* Portfolio management
+* Backtesting and performance analysis reports [example](./examples/backtest_example)
+* Backtesting multiple algorithms with different backtest date ranges [example](./examples/backtests_example)
+* Portfolio management and tracking
+* Tracing for analyzing and debugging your trading bot
 * Web API for interacting with your deployed trading bot
 * Data persistence through sqlite db or an in-memory db
 * Stateless running for cloud function deployments
@@ -68,9 +69,6 @@ bitvavo_btc_eur_ticker = CCXTTickerMarketDataSource(
 )
 app = create_app(config=config)
 algorithm = Algorithm()
-
-app.add_market_data_source(bitvavo_btc_eur_ohlcv_2h)
-app.add_market_data_source(bitvavo_btc_eur_ticker)
 app.add_market_credential(MarketCredential(
     market="bitvavo",
     api_key="<your api key>",
@@ -90,7 +88,7 @@ app.add_algorithm(algorithm)
     time_unit=TimeUnit.HOUR, 
     interval=2, 
     # Specify market data sources that need to be passed to the strategy
-    market_data_sources=["BTC-ticker", "BTC-ohlcv"]
+    market_data_sources=[bitvavo_btc_eur_ticker, bitvavo_btc_eur_ohlcv_2h]
 )
 def perform_strategy(algorithm: Algorithm, market_data: dict):
     # By default, ohlcv data is passed as polars df in the form of
@@ -140,64 +138,82 @@ you will get the following backtesting report:
  
 ```bash
 
-                          /&#                                      #&(                 Backtest report
-                          &&&&&&&&&&&#                       &&&&&&&&&&&&              ---------------------------
-                         &&&&&&&&&&&&&&&&                (&&&&&&&&&&&&&&&              Start date: 2023-08-24 00:00:00
-                         &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&              End date: 2023-12-02 00:00:00
-                         &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&              Number of days: 100 
-                          &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&              Number of runs: 1201
-                          .&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&               Number of orders: 10
-                           &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.               Initial balance: 400.0
-                          &&&&&&&#  /(((   &&&&&&&&&&&&*(((     .&&&&&&&.              Final balance: 431.1499      
-              &&&&&&&&&&&&&&&&&&&    ((((    &&&&&&&&   ((((     &&&&&&&&&&&&&&&&&&&   Total net gain: 28.5542 7.139%  
-                       (((&&&&&&&&    ((((    &&&&&&     ((((   &&&&&&&&&((            Growth: 31.1499 7.787%             
-               /((((((((((&&&&&&&&&&   (((,   &&&&&&      (((**&&&&&&&&&(((((((((((    Number of trades closed: 4
-                     &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&          Number of trades open(end of backtest): 2
-                            &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&                 Percentage positive trades: 60.0%
-                              &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&                   Percentage negative trades: 20.0%
-                     (((((      &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&(                      Average trade size: 98.9886 EUR
-                    (((((           &&&&&&&&&&&&&&&&&&&&&&&&,                          Average trade duration: 184.0 hours
-                   (((((                 &&&&&&&&&&&&&#                            
-                  (((((                  #&&&&&&&&&&###                            
-                 (((((                   &&&&&&&&&&&###.                           
-               .(((((                   &&&&&&&&&&&&&&###(                          
-              (((((                   &&&&&&&&&&&&&&&&#(((/                        
-             (((((                  &&&&&&&&&&&&&&&&&&&@((((                       
-            (((((                  &&&&&&&&&&&&&&&&&&&&&&((((                      
-           (((((                  &&&&&&&&&&&&&&&&&&&&&&&&((((,                    
-         .(((((                   &&&&&&&&&&&&&&&&&&&&&&&&&&((((                    
-        (((((                   &&&&&&&&&&&&&&&&&&&&&&&&&&&&((((                   
-       (((((                    &&&&&&&&&&&&&&&&&&&&&&&&&&&&&((((                  
-      (((((                    &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&((((                  
-     (((((                     &&&&&&&&&&&&&&&&&&&&&&&&&&&&&#((((                  
-     (((((((((((((((((((#########&&&&&&&&&&&&&&&&&&&&&&&&&&&&(((((                  
-      (((((((((((((((((((((######&&&&&&&&&&&&&&&&&&&&&&&&&&&&((((                   
+                  :%%%#+-          .=*#%%%        Backtest report
+                  *%%%%%%%+------=*%%%%%%%-       ---------------------------
+                  *%%%%%%%%%%%%%%%%%%%%%%%-       Start date: 2023-08-24 00:00:00
+                  .%%%%%%%%%%%%%%%%%%%%%%#        End date: 2023-12-02 00:00:00
+                   #%%%####%%%%%%%%**#%%%+        Number of days: 100 
+             .:-+*%%%%- -+..#%%%+.+-  +%%%#*=-:   Number of runs: 1201
+              .:-=*%%%%. += .%%#  -+.-%%%%=-:..   Number of orders: 40
+              .:=+#%%%%%*###%%%%#*+#%%%%%%*+-:    Initial balance: 400.0
+                    +%%%%%%%%%%%%%%%%%%%=         Final balance: 428.2434
+                :++  .=#%%%%%%%%%%%%%*-           Total net gain: 28.2434 7.061%
+               :++:      :+%%%%%%#-.              Growth: 28.2434 7.061%
+              :++:        .%%%%%#=                Number of trades closed: 20
+             :++:        .#%%%%%#*=               Number of trades open(end of backtest): 0
+            :++-        :%%%%%%%%%+=              Percentage positive trades: 30.0%
+           .++-        -%%%%%%%%%%%+=             Percentage negative trades: 70.0%
+          .++-        .%%%%%%%%%%%%%+=            Average trade size: 100.9692 EUR
+         .++-         *%%%%%%%%%%%%%*+:           Average trade duration: 83.6 hours
+        .++-          %%%%%%%%%%%%%%#+=         
+        =++........:::%%%%%%%%%%%%%%*+-         
+        .=++++++++++**#%%%%%%%%%%%%%++.         
         
+Price noise
+
 Positions overview
 ╭────────────┬──────────┬──────────────────────┬───────────────────────┬──────────────┬───────────────┬───────────────────────────┬────────────────┬───────────────╮
 │ Position   │   Amount │   Pending buy amount │   Pending sell amount │   Cost (EUR) │   Value (EUR) │ Percentage of portfolio   │   Growth (EUR) │ Growth_rate   │
 ├────────────┼──────────┼──────────────────────┼───────────────────────┼──────────────┼───────────────┼───────────────────────────┼────────────────┼───────────────┤
-│ EUR        │ 217.044  │                    0 │                     0 │      217.044 │       217.044 │ 50.3407%                  │         0      │ 0.0000%       │
+│ EUR        │  428.243 │                    0 │                     0 │      428.243 │       428.243 │ 100.0000%                 │              0 │ 0.0000%       │
 ├────────────┼──────────┼──────────────────────┼───────────────────────┼──────────────┼───────────────┼───────────────────────────┼────────────────┼───────────────┤
-│ BTC        │   0.003  │                    0 │                     0 │      104.372 │       106.84  │ 24.7802%                  │         2.4678 │ 2.3644%       │
+│ DOT        │    0     │                    0 │                     0 │        0     │         0     │ 0.0000%                   │              0 │ 0.0000%       │
 ├────────────┼──────────┼──────────────────────┼───────────────────────┼──────────────┼───────────────┼───────────────────────────┼────────────────┼───────────────┤
-│ DOT        │  21.3295 │                    0 │                     0 │      107.138 │       107.266 │ 24.8791%                  │         0.128  │ 0.1195%       │
+│ BTC        │    0     │                    0 │                     0 │        0     │         0     │ 0.0000%                   │              0 │ 0.0000%       │
 ╰────────────┴──────────┴──────────────────────┴───────────────────────┴──────────────┴───────────────┴───────────────────────────┴────────────────┴───────────────╯
 Trades overview
 ╭─────────┬─────────────────────┬─────────────────────┬────────────────────┬──────────────┬──────────────────┬───────────────────────┬────────────────────┬─────────────────────╮
 │ Pair    │ Open date           │ Close date          │   Duration (hours) │   Size (EUR) │   Net gain (EUR) │ Net gain percentage   │   Open price (EUR) │   Close price (EUR) │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ DOT-EUR │ 2023-11-30 18:00:00 │                     │            3207.26 │     107.138  │           0      │ 0.0000%               │             5.023  │                     │
+│ DOT-EUR │ 2023-11-24 12:00:00 │ 2023-11-27 14:00:00 │                 74 │     107.55   │          -1.9587 │ -1.8212%              │             4.777  │              4.69   │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-11-20 00:00:00 │ 2023-11-21 08:00:00 │                 32 │     109.39   │          -4.5949 │ -4.2005%              │             4.9875 │              4.778  │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-11-19 22:00:00 │ 2023-11-22 00:00:00 │                 50 │     109.309  │          -2.7624 │ -2.5272%              │         34159.1    │          33295.9    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-11-06 12:00:00 │ 2023-11-13 14:00:00 │                170 │     107.864  │           6.1015 │ 5.6567%               │         32685.9    │          34534.9    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-10-20 12:00:00 │ 2023-10-27 08:00:00 │                164 │      99.085  │          10.9799 │ 11.0813%              │             3.5465 │              3.9395 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-10-14 04:00:00 │ 2023-10-27 22:00:00 │                330 │      97.4278 │          24.137  │ 24.7742%              │         25638.9    │          31990.7    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-10-14 04:00:00 │ 2023-10-17 14:00:00 │                 82 │      99.5572 │          -1.8877 │ -1.8961%              │             3.56   │              3.4925 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-10-07 08:00:00 │ 2023-10-08 08:00:00 │                 24 │      99.9498 │          -1.5708 │ -1.5716%              │             3.8815 │              3.8205 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-09-27 10:00:00 │ 2023-10-05 20:00:00 │                202 │      98.2888 │           3.433  │ 3.4927%               │         25202.2    │          26082.5    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-27 10:00:00 │ 2023-10-03 20:00:00 │                154 │      98.7893 │           1.2085 │ 1.2233%               │             3.842  │              3.889  │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-25 12:00:00 │ 2023-09-27 04:00:00 │                 40 │      98.9193 │          -0.5194 │ -0.5251%              │             3.809  │              3.789  │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-14 16:00:00 │ 2023-09-18 02:00:00 │                 82 │      98.9419 │          -0.0912 │ -0.0921%              │             3.799  │              3.7955 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ BTC-EUR │ 2023-09-07 06:00:00 │ 2023-09-10 16:00:00 │                 82 │      98.6093 │           0.3412 │ 0.3460%               │         24051      │          24134.3    │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-07 00:00:00 │ 2023-09-09 02:00:00 │                 50 │      98.9158 │          -0.2358 │ -0.2383%              │             3.986  │              3.9765 │
+├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
+│ DOT-EUR │ 2023-09-05 14:00:00 │ 2023-09-06 12:00:00 │                 22 │      99.2132 │          -1.1909 │ -1.2003%              │             3.999  │              3.951  │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ BTC-EUR │ 2023-11-29 12:00:00 │                     │            3237.26 │     104.372  │           0      │ 0.0000%               │         34790.7    │                     │
+│ DOT-EUR │ 2023-09-04 16:00:00 │ 2023-09-04 22:00:00 │                  6 │      99.355  │          -0.5671 │ -0.5708%              │             3.942  │              3.9195 │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ BTC-EUR │ 2023-11-07 22:00:00 │ 2023-11-14 14:00:00 │             160    │      99.2337 │           2.5395 │ 2.5591%               │         33077.9    │          33924.4    │
+│ DOT-EUR │ 2023-09-04 10:00:00 │ 2023-09-04 14:00:00 │                  4 │      99.4774 │          -0.4889 │ -0.4914%              │             3.968  │              3.9485 │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ BTC-EUR │ 2023-11-06 14:00:00 │ 2023-11-06 18:00:00 │               4    │      98.2854 │          -0.4248 │ -0.4322%              │         32761.8    │          32620.2    │
+│ BTC-EUR │ 2023-08-26 10:00:00 │ 2023-08-26 18:00:00 │                  8 │      99.0829 │          -0.03   │ -0.0302%              │         24166.6    │          24159.3    │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ DOT-EUR │ 2023-10-30 04:00:00 │ 2023-11-14 00:00:00 │             356    │     100.537  │          24.2886 │ 24.1588%              │             4.0565 │              5.0365 │
+│ DOT-EUR │ 2023-08-25 10:00:00 │ 2023-08-28 10:00:00 │                 72 │      99.659  │          -0.6975 │ -0.6999%              │             4.1435 │              4.1145 │
 ├─────────┼─────────────────────┼─────────────────────┼────────────────────┼──────────────┼──────────────────┼───────────────────────┼────────────────────┼─────────────────────┤
-│ BTC-EUR │ 2023-09-13 14:00:00 │ 2023-09-22 14:00:00 │             216    │      97.8976 │           2.1508 │ 2.1970%               │         24474.4    │          25012.1    │
+│ DOT-EUR │ 2023-08-24 00:00:00 │ 2023-08-25 00:00:00 │                 24 │      99.9999 │          -1.3626 │ -1.3626%              │             4.1465 │              4.09   │
 ╰─────────┴─────────────────────┴─────────────────────┴────────────────────┴──────────────┴──────────────────┴───────────────────────┴────────────────────┴─────────────────────╯
 ```
 

{investing_algorithm_framework-3.5.2 → investing_algorithm_framework-3.7.0}/investing_algorithm_framework/__init__.py

@@ -9,12 +9,16 @@ from investing_algorithm_framework.domain import ApiException, \
     Trade, OHLCVMarketDataSource, OrderBookMarketDataSource, SYMBOLS, \
     TickerMarketDataSource, MarketService, BacktestReportsEvaluation, \
     pretty_print_backtest_reports_evaluation, load_backtest_reports, \
-    RESERVED_BALANCES, APP_MODE, AppMode, DATETIME_FORMAT
+    RESERVED_BALANCES, APP_MODE, AppMode, DATETIME_FORMAT, \
+    load_backtest_report, BacktestDateRange, create_ema_graph, \
+    create_prices_graph, create_rsi_graph, get_price_efficiency_ratio
 from investing_algorithm_framework.infrastructure import \
     CCXTOrderBookMarketDataSource, CCXTOHLCVMarketDataSource, \
     CCXTTickerMarketDataSource, CSVOHLCVMarketDataSource, \
     CSVTickerMarketDataSource
 from .create_app import create_app
+from investing_algorithm_framework.services import \
+    create_trade_exit_markers_chart, create_trade_entry_markers_chart
 
 __all__ = [
     "Algorithm",
@@ -61,4 +65,12 @@ __all__ = [
     "APP_MODE",
     "AppMode",
     "DATETIME_FORMAT",
+    "load_backtest_report",
+    "BacktestDateRange",
+    "create_trade_exit_markers_chart",
+    "create_trade_entry_markers_chart",
+    "create_ema_graph",
+    "create_prices_graph",
+    "create_rsi_graph",
+    "get_price_efficiency_ratio"
 ]

{investing_algorithm_framework-3.5.2 → investing_algorithm_framework-3.7.0}/investing_algorithm_framework/app/algorithm.py

@@ -1,8 +1,8 @@
 import inspect
 import logging
-from typing import List
+from typing import List, Dict
 
-from investing_algorithm_framework.domain import OrderStatus, OrderFee, \
+from investing_algorithm_framework.domain import OrderStatus, \
     Position, Order, Portfolio, OrderType, OrderSide, \
     BACKTESTING_FLAG, BACKTESTING_INDEX_DATETIME, MarketService, TimeUnit, \
     OperationalException, random_string, RoundingService
@@ -16,9 +16,30 @@ logger = logging.getLogger("investing_algorithm_framework")
 
 
 class Algorithm:
-
-    def __init__(self, name=None, description=None):
+    """
+    Class to represent an algorithm. An algorithm is a collection of
+    strategies that are executed in a specific order. The algorithm
+    class is responsible for managing the strategies and executing
+    them in the correct order.
+
+    :param (optional) name: The name of the algorithm
+    :param (optional) description: The description of the algorithm
+    :param (optional) context: The context of the algorithm,
+    for backtest references
+    :param (optional) strategy: A single strategy to add to the algorithm
+    :param (optional) data_sources: The list of data sources to
+    add to the algorithm
+    """
+    def __init__(
+        self,
+        name: str = None,
+        description: str = None,
+        context: Dict = None,
+        strategy=None,
+        data_sources=None
+    ):
         self._name = name
+        self._context = {}
 
         if name is None:
             self._name = f"algorithm_{random_string(10)}"
@@ -28,6 +49,9 @@ class Algorithm:
         if description is not None:
             self._description = description
 
+        if context is not None:
+            self.add_context(context)
+
         self._strategies = []
         self._tasks = []
         self.portfolio_service: PortfolioService
@@ -37,12 +61,18 @@ class Algorithm:
         self.configuration_service: ConfigurationService
         self.portfolio_configuration_service: PortfolioConfigurationService
         self.strategy_orchestrator_service: StrategyOrchestratorService
-        self._market_data_sources = {}
+        self._data_sources = {}
         self._strategies = []
         self._market_credential_service: MarketCredentialService
         self._market_data_source_service: MarketDataSourceService
         self.trade_service: TradeService
 
+        if strategy is not None:
+            self.add_strategy(strategy)
+
+        if data_sources is not None:
+            self.add_data_sources(data_sources)
+
     def initialize_services(
         self,
         configuration_service,
@@ -66,7 +96,7 @@ class Algorithm:
             = portfolio_configuration_service
         self.strategy_orchestrator_service: StrategyOrchestratorService \
             = strategy_orchestrator_service
-        self._market_data_sources = {}
+        self._data_sources = {}
         self._market_credential_service: MarketCredentialService \
             = market_credential_service
         self._market_data_source_service: MarketDataSourceService \
@@ -90,6 +120,10 @@ class Algorithm:
     def name(self):
         return self._name
 
+    @property
+    def data_sources(self):
+        return self._data_sources
+
     @property
     def identifier(self):
         """
@@ -108,6 +142,33 @@ class Algorithm:
         """
         return self.configuration_service.config
 
+    @property
+    def description(self):
+        """
+        Function to get the description of the algorithm
+        """
+        return self._description
+
+    @property
+    def context(self):
+        """
+        Function to get the context of the algorithm
+        """
+        return self._context
+
+    def add_context(self, context: Dict):
+        # Check if the context is a dictionary with only string,
+        # float or int values
+        for key, value in self.context.items():
+            if not isinstance(key, str) or \
+                    not isinstance(value, (str, float, int)):
+                raise OperationalException(
+                    "The context for an algorithm must be a dictionary with "
+                    "only string, float or int values."
+                )
+
+        self._context = context
+
     @property
     def running(self) -> bool:
         """
@@ -362,9 +423,6 @@ class Algorithm:
             }
         )
 
-    def get_order_fee(self, order_id) -> OrderFee:
-        return self.order_service.get_order_fee(order_id)
-
     def get_positions(
         self,
         market=None,
@@ -699,6 +757,9 @@ class Algorithm:
                 "with the same id in the algorithm"
             )
 
+        if strategy.market_data_sources is not None:
+            self.add_data_sources(strategy.market_data_sources)
+
         self._strategies.append(strategy)
 
     @property
@@ -989,6 +1050,9 @@ class Algorithm:
 
         self._tasks.append(task)
 
+    def add_data_sources(self, data_sources):
+        self._data_sources = data_sources
+
     @property
     def tasks(self):
         return self._tasks