bbstrader 0.2.98__tar.gz → 0.2.99__tar.gz

{bbstrader-0.2.98/bbstrader.egg-info → bbstrader-0.2.99}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bbstrader
-Version: 0.2.98
+Version: 0.2.99
 Summary: Simplified Investment & Trading Toolkit
 Home-page: https://github.com/bbalouki/bbstrader
 Download-URL: https://pypi.org/project/bbstrader/

{bbstrader-0.2.98 → bbstrader-0.2.99}/bbstrader/btengine/backtest.py

@@ -4,7 +4,7 @@ from datetime import datetime
 from typing import List, Literal, Optional
 
 from tabulate import tabulate
-
+from bbstrader.btengine.event import Events
 from bbstrader.btengine.data import DataHandler
 from bbstrader.btengine.execution import ExecutionHandler, SimExecutionHandler
 from bbstrader.btengine.portfolio import Portfolio
@@ -165,19 +165,19 @@ class BacktestEngine(Backtest):
                     break
                 else:
                     if event is not None:
-                        if event.type == "MARKET":
+                        if event.type == Events.MARKET:
                             self.strategy.calculate_signals(event)
                             self.portfolio.update_timeindex(event)
 
-                        elif event.type == "SIGNAL":
+                        elif event.type == Events.SIGNAL:
                             self.signals += 1
                             self.portfolio.update_signal(event)
 
-                        elif event.type == "ORDER":
+                        elif event.type == Events.ORDER:
                             self.orders += 1
                             self.execution_handler.execute_order(event)
 
-                        elif event.type == "FILL":
+                        elif event.type == Events.FILL:
                             self.fills += 1
                             self.portfolio.update_fill(event)
                             self.strategy.update_trades_from_fill(event)
@@ -354,7 +354,7 @@ def run_backtest_with(engine: Literal["bbstrader", "cerebro", "zipline"], **kwar
         )
     elif engine == "cerebro":
         # TODO:
-        pass
+        raise NotImplementedError("cerebro engine is not supported yet")
     elif engine == "zipline":
         # TODO:
-        pass
+        raise NotImplementedError("zipline engine is not supported yet")

{bbstrader-0.2.98 → bbstrader-0.2.99}/bbstrader/btengine/event.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from enum import Enum
 from typing import Literal
 
 __all__ = ["Event", "MarketEvent", "SignalEvent", "OrderEvent", "FillEvent"]
@@ -18,6 +19,13 @@ class Event(object):
     ...
 
 
+class Events(Enum):
+    MARKET = "MARKET"
+    SIGNAL = "SIGNAL"
+    ORDER = "ORDER"
+    FILL = "FILL"
+
+
 class MarketEvent(Event):
     """
     Market Events are triggered when the outer while loop of the backtesting
@@ -32,7 +40,7 @@ class MarketEvent(Event):
         """
         Initialises the MarketEvent.
         """
-        self.type = "MARKET"
+        self.type = Events.MARKET
 
 
 class SignalEvent(Event):
@@ -72,7 +80,7 @@ class SignalEvent(Event):
             price (int | float): An optional price to be used when the signal is generated.
             stoplimit (int | float): An optional stop-limit price for the signal
         """
-        self.type = "SIGNAL"
+        self.type = Events.SIGNAL
         self.strategy_id = strategy_id
         self.symbol = symbol
         self.datetime = datetime
@@ -118,7 +126,7 @@ class OrderEvent(Event):
             price (int | float): The price at which to order.
             signal (str): The signal that generated the order.
         """
-        self.type = "ORDER"
+        self.type = Events.ORDER
         self.symbol = symbol
         self.order_type = order_type
         self.quantity = quantity
@@ -191,7 +199,7 @@ class FillEvent(Event):
             commission (float | None): An optional commission sent from IB.
             order (str): The order that this fill is related
         """
-        self.type = "FILL"
+        self.type = Events.FILL
         self.timeindex = timeindex
         self.symbol = symbol
         self.exchange = exchange

{bbstrader-0.2.98 → bbstrader-0.2.99}/bbstrader/btengine/execution.py

@@ -4,7 +4,7 @@ from queue import Queue
 from loguru import logger
 
 from bbstrader.btengine.data import DataHandler
-from bbstrader.btengine.event import FillEvent, OrderEvent
+from bbstrader.btengine.event import Events, FillEvent, OrderEvent
 from bbstrader.config import BBSTRADER_DIR
 from bbstrader.metatrader.account import Account
 
@@ -80,7 +80,7 @@ class SimExecutionHandler(ExecutionHandler):
         Args:
             event (OrderEvent): Contains an Event object with order information.
         """
-        if event.type == "ORDER":
+        if event.type == Events.ORDER:
             dtime = self.bardata.get_latest_bar_datetime(event.symbol)
             fill_event = FillEvent(
                 timeindex=dtime,
@@ -233,7 +233,7 @@ class MT5ExecutionHandler(ExecutionHandler):
         Args:
             event (OrderEvent): Contains an Event object with order information.
         """
-        if event.type == "ORDER":
+        if event.type == Events.ORDER:
             symbol = event.symbol
             direction = event.direction
             quantity = event.quantity

{bbstrader-0.2.98 → bbstrader-0.2.99}/bbstrader/btengine/portfolio.py

@@ -6,7 +6,7 @@ import pandas as pd
 import quantstats as qs
 
 from bbstrader.btengine.data import DataHandler
-from bbstrader.btengine.event import FillEvent, MarketEvent, OrderEvent, SignalEvent
+from bbstrader.btengine.event import Events, FillEvent, MarketEvent, OrderEvent, SignalEvent
 from bbstrader.btengine.performance import (
     create_drawdowns,
     create_sharpe_ratio,
@@ -282,7 +282,7 @@ class Portfolio(object):
         Updates the portfolio current positions and holdings
         from a FillEvent.
         """
-        if event.type == "FILL":
+        if event.type == Events.FILL:
             self.update_positions_from_fill(event)
             self.update_holdings_from_fill(event)
 
@@ -337,7 +337,7 @@ class Portfolio(object):
         Acts on a SignalEvent to generate new orders
         based on the portfolio logic.
         """
-        if event.type == "SIGNAL":
+        if event.type == Events.SIGNAL:
             order_event = self.generate_order(event)
             self.events.put(order_event)
 

{bbstrader-0.2.98 → bbstrader-0.2.99}/bbstrader/btengine/strategy.py

@@ -10,7 +10,7 @@ import pytz
 from loguru import logger
 
 from bbstrader.btengine.data import DataHandler
-from bbstrader.btengine.event import FillEvent, SignalEvent
+from bbstrader.btengine.event import Events, FillEvent, SignalEvent
 from bbstrader.config import BBSTRADER_DIR
 from bbstrader.metatrader.account import (
     Account,
@@ -188,7 +188,7 @@ class MT5Strategy(Strategy):
         This method updates the trades for the strategy based on the fill event.
         It is used to keep track of the number of trades executed for each order.
         """
-        if event.type == "FILL":
+        if event.type == Events.FILL:
             if event.order != "EXIT":
                 self._trades[event.symbol][event.order] += 1
             elif event.order == "EXIT" and event.direction == "BUY":
@@ -678,6 +678,12 @@ class MT5Strategy(Strategy):
         if period_count == 0 or period_count is None:
             return True
         return period_count % signal_inverval == 0
+    
+    @staticmethod
+    def stop_time(time_zone: str, stop_time: str) -> bool:
+        now = datetime.now(pytz.timezone(time_zone)).time()
+        stop_time = datetime.strptime(stop_time, "%H:%M").time()
+        return now >= stop_time
 
     def ispositions(
         self, symbol, strategy_id, position, max_trades, one_true=False, account=None

{bbstrader-0.2.98 → bbstrader-0.2.99}/bbstrader/metatrader/account.py

@@ -1059,7 +1059,7 @@ class Account(object):
             if book is None:
                 return None
             else:
-                return Tuple([BookInfo(**entry._asdict()) for entry in book])
+                return tuple([BookInfo(**entry._asdict()) for entry in book])
         except Exception as e:
             raise_mt5_error(e)
 

bbstrader-0.2.99/bbstrader/metatrader/analysis.py

@@ -0,0 +1,98 @@
+import matplotlib.pyplot as plt
+import MetaTrader5 as mt5
+import numpy as np
+import pandas as pd
+import seaborn as sns
+
+from bbstrader.metatrader.account import check_mt5_connection
+from bbstrader.metatrader.utils import TIMEFRAMES
+
+sns.set_theme()
+
+
+def _get_data(path, symbol, timeframe, bars):
+    check_mt5_connection(path=path)
+    rates = mt5.copy_rates_from_pos(symbol, timeframe, 0, bars)
+    df = pd.DataFrame(rates)
+    df["time"] = pd.to_datetime(df["time"], unit="s")
+    return df
+
+
+def volume_profile(df, bins):
+    prices = (df["high"] + df["low"]) / 2
+    volumes = df["tick_volume"]
+    hist, bin_edges = np.histogram(prices, bins=bins, weights=volumes)
+    bin_centers = 0.5 * (bin_edges[:-1] + bin_edges[1:])
+    return hist, bin_edges, bin_centers
+
+
+def value_area(hist, bin_centers, percentage):
+    total_volume = np.sum(hist)
+    poc_index = np.argmax(hist)
+    poc = bin_centers[poc_index]
+
+    sorted_indices = np.argsort(hist)[::-1]
+    volume_accum = 0
+    value_area_indices = []
+
+    for idx in sorted_indices:
+        volume_accum += hist[idx]
+        value_area_indices.append(idx)
+        if volume_accum >= percentage * total_volume:
+            break
+
+    vah = max(bin_centers[i] for i in value_area_indices)
+    val = min(bin_centers[i] for i in value_area_indices)
+    return poc, vah, val
+
+
+def display_volume_profile(
+    symbol,
+    path,
+    timeframe: str = "1m",
+    bars: int = 1440,
+    bins: int = 100,
+    va_percentage: float = 0.7,
+):
+    """
+    Display a volume profile chart for a given market symbol using historical data.
+
+    This function retrieves historical price and volume data for a given symbol and
+    plots a vertical volume profile chart showing the volume distribution across 
+    price levels. It highlights key levels such as:
+        - Point of Control (POC): Price level with the highest traded volume.
+        - Value Area High (VAH): Upper bound of the value area.
+        - Value Area Low (VAL): Lower bound of the value area.
+        - Current Price: Latest bid price from MetaTrader 5.
+
+    Args:
+        symbol (str): Market symbol (e.g., "AAPL", "EURUSD").
+        path (str): Path to the historical data see ``bbstrader.metatrader.account.check_mt5_connection()``.
+        timeframe (str, optional): Timeframe for each candle (default is "1m").
+        bars (int, optional): Number of historical bars to fetch (default is 1440).
+        bins (int, optional): Number of price bins for volume profile calculation (default is 100).
+        va_percentage (float, optional): Percentage of total volume to define the value area (default is 0.7).
+
+    Returns:
+        None: Displays a matplotlib chart of the volume profile.
+    """
+    df = _get_data(path, symbol, TIMEFRAMES[timeframe], bars)
+    hist, bin_edges, bin_centers = volume_profile(df, bins)
+    poc, vah, val = value_area(hist, bin_centers, va_percentage)
+    current_price = mt5.symbol_info_tick(symbol).bid
+
+    plt.figure(figsize=(6, 10))
+    plt.barh(bin_centers, hist, height=bin_centers[1] - bin_centers[0], color="skyblue")
+    plt.axhline(poc, color="red", linestyle="--", label=f"POC: {poc:.5f}")
+    plt.axhline(vah, color="green", linestyle="--", label=f"VAH: {vah:.5f}")
+    plt.axhline(val, color="orange", linestyle="--", label=f"VAL: {val:.5f}")
+    plt.axhline(
+        current_price, color="black", linestyle=":", label=f"Price: {current_price:.5f}"
+    )
+    plt.legend()
+    plt.title("Volume Profile")
+    plt.xlabel("Volume")
+    plt.ylabel("Price")
+    plt.grid(True)
+    plt.tight_layout()
+    plt.show()

{bbstrader-0.2.98 → bbstrader-0.2.99}/bbstrader/metatrader/copier.py

@@ -486,12 +486,7 @@ class TradeCopier(object):
         )
         return source_orders, dest_orders
 
-    def copy_orders(self, destination: dict):
-        assert destination.get("copy", False), "Destination account not set to copy"
-        what = destination.get("copy_what", "all")
-        if what not in ["all", "orders"]:
-            return
-        check_mt5_connection(**destination)
+    def _copy_new_orders(self, destination):
         source_orders, destination_orders = self.get_orders(destination)
         # Check for new orders
         dest_ids = [order.magic for order in destination_orders]
@@ -500,6 +495,7 @@ class TradeCopier(object):
                 if not self.slippage(source_order, destination):
                     self.copy_new_order(source_order, destination)
 
+    def _copy_modified_orders(self, destination):
         # Check for modified orders
         source_orders, destination_orders = self.get_orders(destination)
         for source_order in source_orders:
@@ -509,6 +505,8 @@ class TradeCopier(object):
                         ticket = destination_order.ticket
                         symbol = destination_order.symbol
                         self.modify_order(ticket, symbol, source_order, destination)
+
+    def _copy_closed_orders(self, destination):
         # Check for closed orders
         source_orders, destination_orders = self.get_orders(destination)
         source_ids = [order.ticket for order in source_orders]
@@ -519,8 +517,8 @@ class TradeCopier(object):
                 )
                 self.remove_order(src_symbol, destination_order, destination)
 
-        # Check if order are triggered on source account
-        # and not on destination account or vice versa
+    def _sync_positions(self, what, destination):
+        # Update postions
         source_positions, _ = self.get_positions(destination)
         _, destination_orders = self.get_orders(destination)
         for source_position in source_positions:
@@ -533,6 +531,8 @@ class TradeCopier(object):
                         if not self.slippage(source_position, destination):
                             self.copy_new_position(source_position, destination)
 
+    def _sync_orders(self, destination):
+        # Update orders
         _, destination_positions = self.get_positions(destination)
         source_orders, _ = self.get_orders(destination)
         for destination_position in destination_positions:
@@ -543,16 +543,25 @@ class TradeCopier(object):
                     )
                     if not self.slippage(source_order, destination):
                         self.copy_new_order(source_order, destination)
-        Mt5.shutdown()
 
-    def copy_positions(self, destination: dict):
-        assert destination.get("copy", False), "Destination account not set to copy"
-        what = destination.get("copy_what", "all")
-        if what not in ["all", "positions"]:
+    def _copy_what(self, destination):
+        if not destination.get("copy", False):
+            raise ValueError("Destination account not set to copy mode")
+        return destination.get("copy_what", "all")
+    
+    def copy_orders(self, destination: dict):
+        what = self._copy_what(destination)
+        if what not in ["all", "orders"]:
             return
         check_mt5_connection(**destination)
-        source_positions, destination_positions = self.get_positions(destination)
+        self._copy_new_orders(destination)
+        self._copy_modified_orders(destination)
+        self._copy_closed_orders(destination)
+        self._sync_positions(what, destination)
+        self._sync_orders(destination)
 
+    def _copy_new_positions(self, destination):
+        source_positions, destination_positions = self.get_positions(destination)
         # Check for new positions
         dest_ids = [pos.magic for pos in destination_positions]
         for source_position in source_positions:
@@ -560,6 +569,7 @@ class TradeCopier(object):
                 if not self.slippage(source_position, destination):
                     self.copy_new_position(source_position, destination)
 
+    def _copy_modified_positions(self, destination):
         # Check for modified positions
         source_positions, destination_positions = self.get_positions(destination)
         for source_position in source_positions:
@@ -571,6 +581,8 @@ class TradeCopier(object):
                         self.modify_position(
                             ticket, symbol, source_position, destination
                         )
+
+    def _copy_closed_position(self, destination):
         # Check for closed positions
         source_positions, destination_positions = self.get_positions(destination)
         source_ids = [pos.ticket for pos in source_positions]
@@ -580,7 +592,15 @@ class TradeCopier(object):
                     destination_position.symbol, destination, type="source"
                 )
                 self.remove_position(src_symbol, destination_position, destination)
-        Mt5.shutdown()
+
+    def copy_positions(self, destination: dict):
+        what = self._copy_what(destination)
+        if what not in ["all", "positions"]:
+            return
+        check_mt5_connection(**destination)
+        self._copy_new_positions(destination)
+        self._copy_modified_positions(destination)
+        self._copy_closed_position(destination)
 
     def log_error(self, e, symbol=None):
         error_msg = repr(e)
@@ -602,8 +622,10 @@ class TradeCopier(object):
                         continue
                     self.copy_orders(destination)
                     self.copy_positions(destination)
+                    Mt5.shutdown()
                     time.sleep(0.1)
             except KeyboardInterrupt:
+                logger.info("Stopping the Trade Copier ...")
                 break
             except Exception as e:
                 self.log_error(e)
@@ -656,6 +678,39 @@ def RunMultipleCopier(
         process.join()
 
 
+def _strtodict(string: str) -> dict:
+    string = string.strip().replace("\n", "").replace(" ", "").replace('"""', "")
+    return dict(item.split(":") for item in string.split(","))
+
+
+def _parse_symbols(section):
+    symbols: str = section.get("symbols")
+    symbols = symbols.strip().replace("\n", " ").replace('"""', "")
+    if symbols in ["all", "*"]:
+        section["symbols"] = symbols
+    elif ":" in symbols:
+        symbols = _strtodict(symbols)
+        section["symbols"] = symbols
+    elif " " in symbols and "," not in symbols:
+        symbols = symbols.split()
+        section["symbols"] = symbols
+    elif "," in symbols:
+        symbols = symbols.replace(" ", "").split(",")
+        section["symbols"] = symbols
+    else:
+        raise ValueError("""
+        Invalid symbols format.
+        You can use space or comma separated symbols in one line or multiple lines using triple quotes.
+        You can also use a dictionary to map source symbols to destination symbols as shown below.
+        Or if you want to copy all symbols, use "all" or "*".
+
+        symbols = EURUSD, GBPUSD, USDJPY (space separated)
+        symbols = EURUSD,GBPUSD,USDJPY (comma separated)
+        symbols = EURUSD.s:EURUSD_i, GBPUSD.s:GBPUSD_i, USDJPY.s:USDJPY_i (dictionary) 
+        symbols = all (copy all symbols)
+        symbols = * (copy all symbols) """)
+
+
 def config_copier(
     source_section: str = None,
     dest_sections: str | List[str] = None,
@@ -681,10 +736,6 @@ def config_copier(
     """
     from bbstrader.core.utils import dict_from_ini
 
-    def strtodict(string: str) -> dict:
-        string = string.strip().replace("\n", "").replace(" ", "").replace('"""', "")
-        return dict(item.split(":") for item in string.split(","))
-
     if not inifile:
         inifile = Path().home() / ".bbstrader" / "copier" / "copier.ini"
         if not inifile.exists() or not inifile.is_file():
@@ -714,33 +765,7 @@ def config_copier(
             raise ValueError(
                 f"Destination section {dest_section} not found in {inifile}"
             )
-        symbols: str = section.get("symbols")
-        symbols = symbols.strip().replace("\n", " ").replace('"""', "")
-        if symbols in ["all", "*"]:
-            section["symbols"] = symbols
-        elif ":" in symbols:
-            symbols = strtodict(symbols)
-            section["symbols"] = symbols
-        elif " " in symbols and "," not in symbols:
-            symbols = symbols.split()
-            section["symbols"] = symbols
-        elif "," in symbols:
-            symbols = symbols.replace(" ", "").split(",")
-            section["symbols"] = symbols
-        else:
-            err_msg = """
-    Invalid symbols format.
-    You can use space or comma separated symbols in one line or multiple lines using triple quotes.
-    You can also use a dictionary to map source symbols to destination symbols as shown below.
-    Or if you want to copy all symbols, use "all" or "*".
-
-    symbols = EURUSD, GBPUSD, USDJPY (space separated)
-    symbols = EURUSD,GBPUSD,USDJPY (comma separated)
-    symbols = EURUSD.s:EURUSD_i, GBPUSD.s:GBPUSD_i, USDJPY.s:USDJPY_i (dictionary) 
-    symbols = all (copy all symbols)
-    symbols = * (copy all symbols) """
-            raise ValueError(err_msg)
-
+        _parse_symbols(section)
         destinations.append(section)
 
     return source, destinations