bbstrader 0.2.4__py3-none-any.whl

bbstrader/config.py

@@ -0,0 +1,133 @@
+import logging
+from pathlib import Path
+from typing import List
+
+AMG_PATH = "C:\\Program Files\\Admirals Group MT5 Terminal\\terminal64.exe"
+FTMO_PATH = "C:\\Program Files\\FTMO MetaTrader 5\\terminal64.exe"
+XCB_PATH = "C:\\Program Files\\4xCube MT5 Terminal\\terminal64.exe"
+TML_PATH = "C:\\Program Files\\Trinota Markets MetaTrader 5 Terminal\\terminal64.exe"
+
+BROKERS_PATHS = {
+    "AMG": AMG_PATH,
+    "FTMO": FTMO_PATH,
+    "XCB": XCB_PATH,
+    "TML": TML_PATH,
+}
+
+
+def get_config_dir(name: str = ".bbstrader") -> Path:
+    """
+    Get the path to the configuration directory.
+
+    Args:
+        name: The name of the configuration directory.
+
+    Returns:
+        The path to the configuration directory.
+    """
+    home_dir = Path.home() / name
+    if not home_dir.exists():
+        home_dir.mkdir()
+    return home_dir
+
+
+BBSTRADER_DIR = get_config_dir()
+
+
+class LogLevelFilter(logging.Filter):
+    def __init__(self, levels: List[int]):
+        """
+        Initializes the filter with specific logging levels.
+
+        Args:
+            levels: A list of logging level values (integers) to include.
+        """
+        super().__init__()
+        self.levels = levels
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """
+        Filters log records based on their level.
+
+        Args:
+            record: The log record to check.
+
+        Returns:
+            True if the record's level is in the allowed levels, False otherwise.
+        """
+        return record.levelno in self.levels
+
+
+class CustomFormatter(logging.Formatter):
+    def formatTime(self, record, datefmt=None):
+        if hasattr(record, "custom_time"):
+            # Use the custom time if provided
+            record.created = record.custom_time.timestamp()
+        return super().formatTime(record, datefmt)
+
+
+class CustomLogger(logging.Logger):
+    def __init__(self, name, level=logging.NOTSET):
+        super().__init__(name, level)
+
+    def _log(
+        self,
+        level,
+        msg,
+        args,
+        exc_info=None,
+        extra=None,
+        stack_info=False,
+        stacklevel=1,
+        custom_time=None,
+    ):
+        if extra is None:
+            extra = {}
+        # Add custom_time to the extra dictionary if provided
+        if custom_time:
+            extra["custom_time"] = custom_time
+        super()._log(level, msg, args, exc_info, extra, stack_info, stacklevel)
+
+    def info(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.INFO, msg, args, custom_time=custom_time, **kwargs)
+
+    def debug(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.DEBUG, msg, args, custom_time=custom_time, **kwargs)
+
+    def warning(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.WARNING, msg, args, custom_time=custom_time, **kwargs)
+
+    def error(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.ERROR, msg, args, custom_time=custom_time, **kwargs)
+
+    def critical(self, msg, *args, custom_time=None, **kwargs):
+        self._log(logging.CRITICAL, msg, args, custom_time=custom_time, **kwargs)
+
+
+def config_logger(log_file: str, console_log=True):
+    # Use the CustomLogger
+    logging.setLoggerClass(CustomLogger)
+    logger = logging.getLogger(__name__)
+    logger.setLevel(logging.DEBUG)
+
+    # File handler
+    file_handler = logging.FileHandler(log_file)
+    file_handler.setLevel(logging.INFO)
+
+    # Custom formatter
+    formatter = CustomFormatter(
+        "%(asctime)s - %(levelname)s: %(message)s", datefmt="%Y-%m-%d %H:%M:%S"
+    )
+    file_handler.setFormatter(formatter)
+
+    # Add the handler to the logger
+    logger.addHandler(file_handler)
+
+    if console_log:
+        # Handler for the console with a different level
+        console_handler = logging.StreamHandler()
+        console_handler.setLevel(logging.DEBUG)
+        console_handler.setFormatter(formatter)
+        logger.addHandler(console_handler)
+
+    return logger

bbstrader/core/data.py

@@ -0,0 +1,22 @@
+from financetoolkit import Toolkit
+
+__all__ = [
+    'FMP',
+]
+
+
+class FMP(Toolkit):
+    """
+    FMPData class for fetching data from Financial Modeling Prep API
+    using the Toolkit class from financetoolkit package.
+
+    See `financetoolkit` for more details.
+
+    """
+
+    def __init__(self, api_key: str = '', symbols: str | list = 'AAPL'):
+        super().__init__(tickers=symbols, api_key=api_key)
+
+
+class DataBendo:
+    ...

bbstrader/core/utils.py

@@ -0,0 +1,57 @@
+from enum import Enum
+from dataclasses import dataclass
+
+
+class TradeAction(Enum):
+    """
+    An enumeration class for trade actions.
+    """
+    BUY = "LONG"
+    LONG = "LONG"
+    SELL = "SHORT"
+    EXIT = "EXIT"
+    BMKT = "BMKT"
+    SMKT = "SMKT"
+    BLMT = "BLMT"
+    SLMT = "SLMT"
+    BSTP = "BSTP"
+    SSTP = "SSTP"
+    SHORT = "SHORT"
+    BSTPLMT = "BSTPLMT"
+    SSTPLMT = "SSTPLMT"
+    EXIT_LONG = "EXIT_LONG"
+    EXIT_SHORT = "EXIT_SHORT"
+    EXIT_STOP = "EXIT_STOP"
+    EXIT_LIMIT = "EXIT_LIMIT"
+    EXIT_LONG_STOP = "EXIT_LONG_STOP"
+    EXIT_LONG_LIMIT = "EXIT_LONG_LIMIT"
+    EXIT_SHORT_STOP = "EXIT_SHORT_STOP"
+    EXIT_SHORT_LIMIT = "EXIT_SHORT_LIMIT"
+    EXIT_LONG_STOP_LIMIT = "EXIT_LONG_STOP_LIMIT"
+    EXIT_SHORT_STOP_LIMIT = "EXIT_SHORT_STOP_LIMIT"
+    EXIT_PROFITABLES = "EXIT_PROFITABLES"
+    EXIT_LOSINGS = "EXIT_LOSINGS"
+    EXIT_ALL_POSITIONS = "EXIT_ALL_POSITIONS"
+    EXIT_ALL_ORDERS = "EXIT_ALL_ORDERS"
+
+    def __str__(self):
+        return self.value
+
+
+@dataclass()
+class TradeSignal:
+    """
+    A dataclass for storing trading signal.
+    """
+
+    id: int
+    symbol: str
+    action: TradeAction
+    price: float = None
+    stoplimit: float = None
+
+    def __repr__(self):
+        return (
+            f"TradeSignal(id={self.id}, symbol='{self.symbol}', "
+            f"action='{self.action.value}', price={self.price}, stoplimit={self.stoplimit})"
+        )

bbstrader/metatrader/__init__.py

@@ -0,0 +1,6 @@
+
+from bbstrader.metatrader.account import *  # noqa: F403
+from bbstrader.metatrader.rates import *  # noqa: F403
+from bbstrader.metatrader.risk import *  # noqa: F403
+from bbstrader.metatrader.trade import *  # noqa: F403
+from bbstrader.metatrader.utils import *  # noqa: F403