bbstrader 0.3.6__tar.gz → 0.3.7__tar.gz

{bbstrader-0.3.6/bbstrader.egg-info → bbstrader-0.3.7}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: bbstrader
-Version: 0.3.6
+Version: 0.3.7
 Summary: Simplified Investment & Trading Toolkit
-Author-email: Bertin Balouki SIMYELI <bertin@bbstrader.com>
-Maintainer-email: Bertin Balouki SIMYELI <bertin@bbstrader.com>
+Author-email: Bertin Balouki SIMYELI <bertin@bbs-trading.com>
+Maintainer-email: Bertin Balouki SIMYELI <bertin@bbs-trading.com>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/bbalouki/bbstrader
 Project-URL: Download, https://pypi.org/project/bbstrader/

{bbstrader-0.3.6 → bbstrader-0.3.7}/bbstrader/__init__.py

@@ -5,7 +5,7 @@ Simplified Investment & Trading Toolkit
 
 __author__ = "Bertin Balouki SIMYELI"
 __copyright__ = "2023-2025 Bertin Balouki SIMYELI"
-__email__ = "bertin@bbstrader.com"
+__email__ = "bertin@bbs-trading.com"
 __license__ = "MIT"
 
 from importlib.metadata import version, PackageNotFoundError

{bbstrader-0.3.6 → bbstrader-0.3.7}/bbstrader/__main__.py

@@ -23,7 +23,7 @@ class _Module(Enum):
 FONT = pyfiglet.figlet_format("BBSTRADER", font="big")
 
 
-def main():
+def main() -> None:
     DESCRIPTION = "BBSTRADER"
     USAGE_TEXT = """
     Usage:
@@ -51,7 +51,7 @@ def main():
     if ("-h" in sys.argv or "--help" in sys.argv) and args.run is None:
         print(Fore.WHITE + USAGE_TEXT)
         sys.exit(0)
-    if ("-v" in sys.argv or "--version" in sys.argv):
+    if "-v" in sys.argv or "--version" in sys.argv:
         print(Fore.GREEN + f"bbstrader version {__version__}")
         print(Fore.WHITE + f"bbstrader maintained and supported by {__author__}")
         sys.exit(0)

{bbstrader-0.3.6 → bbstrader-0.3.7}/bbstrader/apps/_copier.py

@@ -12,10 +12,13 @@ from PIL import Image, ImageTk
 from bbstrader.metatrader.copier import copier_worker_process, get_symbols_from_string
 
 
-def resource_path(relative_path):
+from typing import Any, Dict, Union
+
+
+def resource_path(relative_path: str) -> Path:
     """Get absolute path to resource"""
     try:
-        base_path = Path(sys._MEIPASS)
+        base_path = Path(sys._MEIPASS)  # type: ignore
     except AttributeError:
         base_path = Path(__file__).resolve().parent.parent.parent
 
@@ -27,10 +30,10 @@ ICON_PATH = resource_path("assets/bbstrader.ico")
 LOGO_PATH = resource_path("assets/bbstrader.png")
 
 
-class TradeCopierApp(object):
+class TradeCopierApp:
     copier_processes: List[multiprocessing.Process]
 
-    def __init__(self, root: tk.Tk):
+    def __init__(self, root: tk.Tk) -> None:
         root.title(TITLE)
         root.geometry("1600x900")
         self.root = root
@@ -48,13 +51,13 @@ class TradeCopierApp(object):
         self.add_destination_accounts_frame(self.main_frame)
         self.add_copier_settings(self.main_frame)
 
-    def set_style(self):
+    def set_style(self) -> None:
         self.style = ttk.Style()
         self.style.configure("Bold.TLabelframe.Label", font=("Segoe UI", 15, "bold"))
 
-    def add_main_frame(self):
+    def add_main_frame(self) -> ttk.Frame:
         main_frame = ttk.Frame(self.root, padding="10")
-        main_frame.grid(row=0, column=0, sticky=(tk.W, tk.E, tk.N, tk.S))
+        main_frame.grid(row=0, column=0, sticky=(tk.W, tk.E, tk.N, tk.S))  # type: ignore
 
         # Configure the layout
         main_frame.columnconfigure(0, weight=2)
@@ -63,7 +66,7 @@ class TradeCopierApp(object):
 
         # --- visual/logo frame ---
         self.visual_frame = ttk.Frame(main_frame)
-        self.visual_frame.grid(row=0, column=1, padx=5, pady=5, sticky=(tk.W, tk.E))
+        self.visual_frame.grid(row=0, column=1, padx=5, pady=5, sticky=(tk.W, tk.E)) # type: ignore
 
         # --- opier settings---
         self.right_panel_frame = ttk.Frame(main_frame)
@@ -76,12 +79,12 @@ class TradeCopierApp(object):
 
         return main_frame
 
-    def add_source_account_frame(self, main_frame):
+    def add_source_account_frame(self, main_frame: ttk.Frame) -> None:
         # --- Source Account ---
         source_frame = ttk.LabelFrame(
             main_frame, text="Source Account", style="Bold.TLabelframe"
         )
-        source_frame.grid(row=0, column=0, padx=5, pady=5, sticky=(tk.W, tk.E, tk.N))
+        source_frame.grid(row=0, column=0, padx=5, pady=5, sticky=(tk.W, tk.E, tk.N)) # type: ignore
         source_frame.columnconfigure(1, weight=1)
         source_frame.columnconfigure(3, weight=1)
 
@@ -131,13 +134,13 @@ class TradeCopierApp(object):
         )
         self.allow_copy_check.grid(row=1, column=3, sticky=tk.W, padx=5, pady=2)
 
-    def add_destination_accounts_frame(self, main_frame):
+    def add_destination_accounts_frame(self, main_frame: ttk.Frame) -> None:
         # --- Destination Accounts Scrollable Area ---
         self.destinations_outer_frame = ttk.LabelFrame(
             main_frame, text="Destination Accounts", style="Bold.TLabelframe"
         )
         self.destinations_outer_frame.grid(
-            row=1, column=0, padx=5, pady=5, sticky=(tk.W, tk.E, tk.N, tk.S)
+            row=1, column=0, padx=5, pady=5, sticky=(tk.W, tk.E, tk.N, tk.S) # type: ignore
         )
         self.destinations_outer_frame.rowconfigure(0, weight=1)
         self.destinations_outer_frame.columnconfigure(0, weight=1)
@@ -159,10 +162,10 @@ class TradeCopierApp(object):
 
         self.scrollable_frame_for_destinations.columnconfigure(0, weight=1)
 
-        def configure_scroll_region(event):
+        def configure_scroll_region(event: tk.Event) -> None:
             self.canvas.configure(scrollregion=self.canvas.bbox("all"))
 
-        def configure_canvas_window(event):
+        def configure_canvas_window(event: tk.Event) -> None:
             self.canvas.itemconfig(self.canvas_window, width=event.width)
 
         self.scrollable_frame_for_destinations.bind(
@@ -170,7 +173,7 @@ class TradeCopierApp(object):
         )
         self.canvas.bind("<Configure>", configure_canvas_window)
 
-        def _on_mousewheel(event):
+        def _on_mousewheel(event: tk.Event) -> None:
             scroll_val = -1 * (event.delta // 120)
             self.canvas.yview_scroll(scroll_val, "units")
 
@@ -189,12 +192,12 @@ class TradeCopierApp(object):
 
         self.add_destination_account()
 
-    def add_copier_settings(self, main_frame):
+    def add_copier_settings(self, main_frame: ttk.Frame) -> None:
         # --- Copier Settings ---
         settings_frame = ttk.LabelFrame(
             self.right_panel_frame, text="Copier Settings", style="Bold.TLabelframe"
         )
-        settings_frame.grid(row=0, column=0, sticky=(tk.W, tk.E), padx=5, pady=5)
+        settings_frame.grid(row=0, column=0, sticky=(tk.W, tk.E), padx=5, pady=5) # type: ignore
 
         ttk.Label(settings_frame, text="Sleep Time (s)").grid(
             row=0, column=0, sticky=tk.W, padx=5, pady=2
@@ -240,14 +243,14 @@ class TradeCopierApp(object):
             columnspan=2,
             padx=5,
             pady=5,
-            sticky=(tk.W, tk.E, tk.N, tk.S),
+            sticky=(tk.W, tk.E, tk.N, tk.S), # type: ignore
         )
 
         self.log_text = scrolledtext.ScrolledText(log_frame, wrap=tk.WORD, height=10)
         self.log_text.pack(fill=tk.BOTH, expand=True, padx=5, pady=5)
         self.log_text.configure(state="disabled")
 
-    def add_logo_and_description(self):
+    def add_logo_and_description(self) -> None:
         image = Image.open(LOGO_PATH)
         image = image.resize((120, 120))
         self.logo_img = ImageTk.PhotoImage(image)
@@ -262,9 +265,9 @@ class TradeCopierApp(object):
             font=("Segoe UI", 10, "bold"),
         ).pack()
 
-    def add_destination_account(self):
+    def add_destination_account(self) -> None:
         dest_row = len(self.destination_widgets)
-        dest_widgets = {}
+        dest_widgets: Dict[str, Union[ttk.Entry, ttk.Combobox]] = {}
 
         if dest_row > 0:
             sep = ttk.Separator(
@@ -385,13 +388,13 @@ class TradeCopierApp(object):
         self.add_dest_button.grid_forget()
         self.add_dest_button.grid(row=1, column=0, columnspan=2, pady=10, sticky=tk.EW)
 
-    def log_message(self, message):
+    def log_message(self, message: str) -> None:
         self.log_text.configure(state="normal")
         self.log_text.insert(tk.END, message + "\n")
         self.log_text.configure(state="disabled")
         self.log_text.see(tk.END)
 
-    def check_log_queue(self):
+    def check_log_queue(self) -> None:
         try:
             while True:
                 message = self.log_queue.get_nowait()
@@ -413,7 +416,7 @@ class TradeCopierApp(object):
         else:
             return get_symbols_from_string(symbols)
 
-    def _validate_inputs(self):
+    def _validate_inputs(self) -> bool:
         if (
             not self.source_login_entry.get()
             or not self.source_password_entry.get()
@@ -463,11 +466,11 @@ class TradeCopierApp(object):
         # Add more validation for time formats if needed
         return True
 
-    def start_copier(self):
+    def start_copier(self) -> None:
         if not self._validate_inputs():
             return
 
-        source_config = {
+        source_config: Dict[str, Any] = {
             "login": int(self.source_login_entry.get().strip()),
             "password": self.source_password_entry.get().strip(),
             "server": self.source_server_entry.get().strip(),
@@ -476,10 +479,10 @@ class TradeCopierApp(object):
             "unique": not self.allow_copy_var.get(),
         }
 
-        destinations_config = []
+        destinations_config: List[Dict[str, Any]] = []
         for dest_widget_map in self.destination_widgets:
             symbols_str = dest_widget_map["symbols"].get().strip()
-            dest = {
+            dest: Dict[str, Any] = {
                 "login": int(dest_widget_map["login"].get().strip()),
                 "password": dest_widget_map["password"].get().strip(),
                 "server": dest_widget_map["server"].get().strip(),
@@ -510,7 +513,7 @@ class TradeCopierApp(object):
         try:
             # Create shared shutdown event and log queue
             self.shutdown_event = multiprocessing.Event()
-            self.log_queue = multiprocessing.Queue()
+            self.log_queue: "multiprocessing.Queue[str]" = multiprocessing.Queue()
             self.copier_processes = []
 
             # Spawn one process for each destination
@@ -546,7 +549,7 @@ class TradeCopierApp(object):
             self.start_button.config(state=tk.NORMAL)
             self.stop_button.config(state=tk.DISABLED)
 
-    def stop_copier(self):
+    def stop_copier(self) -> None:
         self.log_message("Attempting to stop all Trade Copier processes...")
 
         if not hasattr(self, "copier_processes") or not self.copier_processes:
@@ -581,12 +584,12 @@ class TradeCopierApp(object):
         # Cleanup references
         self.copier_processes = []
         self.shutdown_event = None
-        self.log_queue = None
+        self.log_queue = None # type: ignore
 
         self.start_button.config(state=tk.NORMAL)
         self.stop_button.config(state=tk.DISABLED)
 
-    def browse_path(self, path_entry_widget):
+    def browse_path(self, path_entry_widget: ttk.Entry) -> None:
         filetypes = (("Executable files", "*.exe"), ("All files", "*.*"))
         filepath = filedialog.askopenfilename(
             title="Select MetaTrader Terminal Executable", filetypes=filetypes
@@ -595,7 +598,7 @@ class TradeCopierApp(object):
             path_entry_widget.delete(0, tk.END)
             path_entry_widget.insert(0, filepath)
 
-    def browse_symbols_file(self, symbols_entry_widget):
+    def browse_symbols_file(self, symbols_entry_widget: ttk.Entry) -> None:
         """
         Opens a file dialog to select a .txt file, reads the content,
         and populates the given symbols_entry_widget with a comma-separated list.
@@ -623,7 +626,7 @@ class TradeCopierApp(object):
                 self.log_message(f"Error loading symbols: {e}")
 
 
-def main():
+def main() -> None:
     """
     Main function to initialize and run the Trade Copier GUI.
     """
@@ -632,12 +635,12 @@ def main():
         root.iconbitmap(os.path.abspath(ICON_PATH))
         app = TradeCopierApp(root)
 
-        def on_closing():
+        def on_closing() -> None:
             try:
                 if (
                     hasattr(app, "copier_process")
-                    and app.copier_process
-                    and app.copier_process.is_alive()
+                    and app.copier_process # type: ignore
+                    and app.copier_process.is_alive() # type: ignore
                 ):
                     app.log_message("Window closed, stopping Trade Copier...")
                     app.stop_copier()

{bbstrader-0.3.6 → bbstrader-0.3.7}/bbstrader/btengine/backtest.py

@@ -1,11 +1,13 @@
 import queue
 import time
 from datetime import datetime
-from typing import List, Literal, Optional
+from typing import Any, List, Literal, Optional, Type
 
+import pandas as pd
 from tabulate import tabulate
-from bbstrader.btengine.event import Events
+
 from bbstrader.btengine.data import DataHandler
+from bbstrader.btengine.event import Events
 from bbstrader.btengine.execution import ExecutionHandler, SimExecutionHandler
 from bbstrader.btengine.portfolio import Portfolio
 from bbstrader.btengine.strategy import Strategy
@@ -13,7 +15,7 @@ from bbstrader.btengine.strategy import Strategy
 __all__ = ["Backtest", "BacktestEngine", "run_backtest"]
 
 
-class Backtest(object):
+class Backtest:
     """
     The `Backtest()` object encapsulates the event-handling logic and essentially
     ties together all of the other classes.
@@ -63,12 +65,12 @@ class BacktestEngine(Backtest):
         initial_capital: float,
         heartbeat: float,
         start_date: datetime,
-        data_handler: DataHandler,
-        execution_handler: ExecutionHandler,
-        strategy: Strategy,
+        data_handler: Type[DataHandler],
+        execution_handler: Type[ExecutionHandler],
+        strategy: Type[Strategy],
         /,
-        **kwargs,
-    ):
+        **kwargs: Any,
+    ) -> None:
         """
         Initialises the backtest.
 
@@ -95,7 +97,7 @@ class BacktestEngine(Backtest):
         self.strategy_cls = strategy
         self.kwargs = kwargs
 
-        self.events = queue.Queue()
+        self.events: "queue.Queue[Events]" = queue.Queue()
 
         self.signals = 0
         self.orders = 0
@@ -105,7 +107,7 @@ class BacktestEngine(Backtest):
         self.show_equity = kwargs.get("show_equity", False)
         self.stats_file = kwargs.get("stats_file", None)
 
-    def _generate_trading_instances(self):
+    def _generate_trading_instances(self) -> None:
         """
         Generates the trading instance objects from
         their class types.
@@ -121,7 +123,7 @@ class BacktestEngine(Backtest):
         self.strategy: Strategy = self.strategy_cls(
             bars=self.data_handler, events=self.events, **self.kwargs
         )
-        self.portfolio = Portfolio(
+        self.portfolio: Portfolio = Portfolio(
             self.data_handler,
             self.events,
             self.start_date,
@@ -132,7 +134,7 @@ class BacktestEngine(Backtest):
             self.events, self.data_handler, **self.kwargs
         )
 
-    def _run_backtest(self):
+    def _run_backtest(self) -> None:
         """
         Executes the backtest.
         """
@@ -150,9 +152,9 @@ class BacktestEngine(Backtest):
                 self.strategy.cash = value
             else:
                 print("\n[======= BACKTEST COMPLETED =======]")
-                print(
-                    f"END DATE: {self.data_handler.get_latest_bar_datetime(self.symbol_list[0])}"
-                )
+                dt = self.data_handler.get_latest_bar_datetime(self.symbol_list[0])
+                if dt:
+                    print(f"END DATE: {dt}")
                 print(f"TOTAL BARS: {i} ")
                 print(f"PORFOLIO VALUE: {round(value, 2)}")
                 break
@@ -184,7 +186,7 @@ class BacktestEngine(Backtest):
 
             time.sleep(self.heartbeat)
 
-    def _output_performance(self):
+    def _output_performance(self) -> None:
         """
         Outputs the strategy performance from the backtest.
         """
@@ -218,7 +220,7 @@ class BacktestEngine(Backtest):
                 "\n",
             )
 
-    def simulate_trading(self):
+    def simulate_trading(self) -> pd.DataFrame:
         """
         Simulates the backtest and outputs portfolio performance.
 
@@ -233,13 +235,13 @@ class BacktestEngine(Backtest):
 def run_backtest(
     symbol_list: List[str],
     start_date: datetime,
-    data_handler: DataHandler,
-    strategy: Strategy,
-    exc_handler: Optional[ExecutionHandler] = None,
+    data_handler: Type[DataHandler],
+    strategy: Type[Strategy],
+    exc_handler: Optional[Type[ExecutionHandler]] = None,
     initial_capital: float = 100000.0,
     heartbeat: float = 0.0,
-    **kwargs,
-):
+    **kwargs: Any,
+) -> pd.DataFrame:
     """
     Runs a backtest simulation based on a `DataHandler`, `Strategy`, and `ExecutionHandler`.
 
@@ -315,7 +317,7 @@ def run_backtest(
         ... )
     """
     if exc_handler is None:
-        execution_handler = SimExecutionHandler
+        execution_handler: Type[ExecutionHandler] = SimExecutionHandler
     else:
         execution_handler = exc_handler
     engine = BacktestEngine(
@@ -338,14 +340,16 @@ class CerebroEngine: ...
 class ZiplineEngine: ...
 
 
-def run_backtest_with(engine: Literal["bbstrader", "cerebro", "zipline"], **kwargs):
+def run_backtest_with(
+    engine: Literal["bbstrader", "cerebro", "zipline"], **kwargs: Any
+) -> Optional[pd.DataFrame]:
     """ """
     if engine == "bbstrader":
         return run_backtest(
-            symbol_list=kwargs.get("symbol_list"),
-            start_date=kwargs.get("start_date"),
-            data_handler=kwargs.get("data_handler"),
-            strategy=kwargs.get("strategy"),
+            symbol_list=kwargs.get("symbol_list"),  # type: ignore
+            start_date=kwargs.get("start_date"),  # type: ignore
+            data_handler=kwargs.get("data_handler"),  # type: ignore
+            strategy=kwargs.get("strategy"),  # type: ignore
             exc_handler=kwargs.get("exc_handler"),
             initial_capital=kwargs.get("initial_capital", 100000.0),
             heartbeat=kwargs.get("heartbeat", 0.0),
@@ -357,3 +361,4 @@ def run_backtest_with(engine: Literal["bbstrader", "cerebro", "zipline"], **kwar
     elif engine == "zipline":
         # TODO:
         raise NotImplementedError("zipline engine is not supported yet")
+    return None