bbstrader 0.3.2__tar.gz → 0.3.3__tar.gz

{bbstrader-0.3.2/bbstrader.egg-info → bbstrader-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bbstrader
-Version: 0.3.2
+Version: 0.3.3
 Summary: Simplified Investment & Trading Toolkit
 Home-page: https://github.com/bbalouki/bbstrader
 Download-URL: https://pypi.org/project/bbstrader/
@@ -380,7 +380,7 @@ You may need to create the `~/.bbstrader/` directory and its subdirectories (lik
 
 For comprehensive information, including detailed API references, tutorials, and advanced guides for each module, please refer to our full documentation hosted on ReadTheDocs:
 
-[**View the Full Documentation on ReadTheDocs**](https://bbstrader.readthedocs.io/en/latest/)
+[**View the Full Documentation**](https://bbstrader.readthedocs.io/en/latest/)
 
 Additionally, the codebase is commented and includes docstrings, which can be a valuable resource for understanding the implementation details of specific functions and classes.
 

{bbstrader-0.3.2 → bbstrader-0.3.3}/README.md

@@ -301,7 +301,7 @@ You may need to create the `~/.bbstrader/` directory and its subdirectories (lik
 
 For comprehensive information, including detailed API references, tutorials, and advanced guides for each module, please refer to our full documentation hosted on ReadTheDocs:
 
-[**View the Full Documentation on ReadTheDocs**](https://bbstrader.readthedocs.io/en/latest/)
+[**View the Full Documentation**](https://bbstrader.readthedocs.io/en/latest/)
 
 Additionally, the codebase is commented and includes docstrings, which can be a valuable resource for understanding the implementation details of specific functions and classes.
 

{bbstrader-0.3.2 → bbstrader-0.3.3}/bbstrader/__main__.py

@@ -12,7 +12,7 @@ from bbstrader.metatrader.scripts import copy_trades
 from bbstrader.trading.scripts import execute_strategy
 
 
-class Module(Enum):
+class _Module(Enum):
     COPIER = "copier"
     BACKTEST = "backtest"
     EXECUTION = "execution"
@@ -52,13 +52,13 @@ def main():
         sys.exit(0)
     try:
         match args.run:
-            case Module.COPIER.value:
+            case _Module.COPIER.value:
                 copy_trades(unknown)
-            case Module.BACKTEST.value:
+            case _Module.BACKTEST.value:
                 backtest(unknown)
-            case Module.EXECUTION.value:
+            case _Module.EXECUTION.value:
                 execute_strategy(unknown)
-            case Module.NEWS_FEED.value:
+            case _Module.NEWS_FEED.value:
                 send_news_feed(unknown)
             case _:
                 print(Fore.RED + f"Unknown module: {args.run}")

{bbstrader-0.3.2 → bbstrader-0.3.3}/bbstrader/btengine/data.py

@@ -361,7 +361,7 @@ class CSVDataHandler(BaseCSVDataHandler):
             csv_dir (str): Absolute directory path to the CSV files.
 
         NOTE:
-        All csv fille can be strored in 'Home/.bbstrader/csv_data'
+        All csv fille can be stored in 'Home/.bbstrader/data/csv_data'
 
         """
         csv_dir = kwargs.get("csv_dir")
@@ -580,7 +580,7 @@ class EODHDataHandler(BaseCSVDataHandler):
                 to_unix_time=unix_end,
             )
 
-    def _forma_data(self, data: List[Dict] | pd.DataFrame) -> pd.DataFrame:
+    def _format_data(self, data: List[Dict] | pd.DataFrame) -> pd.DataFrame:
         if isinstance(data, pd.DataFrame):
             if data.empty or len(data) == 0:
                 raise ValueError("No data found.")
@@ -608,7 +608,7 @@ class EODHDataHandler(BaseCSVDataHandler):
             filepath = os.path.join(cache_dir, f"{symbol}.csv")
             try:
                 data = self._get_data(symbol, self.period)
-                data = self._forma_data(data)
+                data = self._format_data(data)
                 data.to_csv(filepath)
             except Exception as e:
                 raise ValueError(f"Error downloading {symbol}: {e}")

{bbstrader-0.3.2 → bbstrader-0.3.3}/bbstrader/btengine/strategy.py

@@ -797,17 +797,19 @@ class MT5Strategy(Strategy):
             return False
         tick_info = self.account.get_tick_info(asset)
         bid, ask = tick_info.bid, tick_info.ask
+        price = None
         if len(prices) == 1:
             price = prices[0]
         elif len(prices) in range(2, self.max_trades[asset] + 1):
             price = np.mean(prices)
-        if (
-            position == 0
-            and self.calculate_pct_change(ask, price) >= th
-            or position == 1
-            and abs(self.calculate_pct_change(bid, price)) >= th
-        ):
-            return True
+        if price is not None:
+            if (
+                position == 0
+                and self.calculate_pct_change(ask, price) >= th
+                or position == 1
+                and abs(self.calculate_pct_change(bid, price)) >= th
+            ):
+                return True
         return False
 
     @staticmethod

{bbstrader-0.3.2 → bbstrader-0.3.3}/bbstrader/core/data.py

@@ -190,7 +190,9 @@ class FmpNews(object):
                 0
             ]  # if symbol is a yahoo finance ticker
         source_methods = {
-            "articles": lambda: self.get_latest_articles(articles=articles, save=True),
+            "articles": lambda: self.get_latest_articles(
+                articles=articles, save=True, **kwargs
+            ),
             "releases": lambda: self.get_releases(symbol=symbol, **kwargs),
             "stock": lambda: self.get_stock_news(symbol=symbol, **kwargs),
             "crypto": lambda: self.get_crypto_news(symbol=symbol, **kwargs),

{bbstrader-0.3.2 → bbstrader-0.3.3}/bbstrader/core/scripts.py

@@ -4,6 +4,7 @@ import sys
 import textwrap
 import time
 from datetime import datetime, timedelta
+from typing import List, Literal
 
 import nltk
 from loguru import logger
@@ -25,7 +26,7 @@ def summarize_text(text, sentences_count=5):
     return " ".join(str(sentence) for sentence in summary)
 
 
-def format_article_for_telegram(article: dict) -> str:
+def format_coindesk_article(article: dict) -> str:
     if not all(
         k in article
         for k in (
@@ -53,16 +54,40 @@ def format_article_for_telegram(article: dict) -> str:
     return text
 
 
-async def send_articles(articles: dict, token: str, id: str, interval=15):
+def format_fmp_article(article: dict) -> str:
+    if not all(k in article for k in ("title", "date", "content", "tickers")):
+        return ""
+    summary = summarize_text(article["content"])
+    text = (
+        f"📰 {article['title']}\n"
+        f"Published Date: {article['date']}\n"
+        f"Keywords: {article['tickers']}\n\n"
+        f"🔍 Summary\n"
+        f"{textwrap.fill(summary, width=80)}"
+    )
+    return text
+
+
+async def send_articles(
+    articles: List[dict],
+    token: str,
+    id: str,
+    source: Literal["coindesk", "fmp"],
+    interval=15,
+):
     for article in articles:
-        if article["published_on"] >= datetime.now() - timedelta(minutes=interval):
-            article["published_on"] = article.get("published_on").strftime(
-                "%Y-%m-%d %H:%M:%S"
-            )
-            message = format_article_for_telegram(article)
-            if message == "":
-                return
-            await send_telegram_message(token, id, text=message)
+        message = ""
+        if source == "coindesk":
+            if article["published_on"] >= datetime.now() - timedelta(minutes=interval):
+                article["published_on"] = article.get("published_on").strftime(
+                    "%Y-%m-%d %H:%M:%S"
+                )
+            message = format_coindesk_article(article)
+        else:
+            message = format_fmp_article(article)
+        if message == "":
+            return
+        await send_telegram_message(token, id, text=message)
 
 
 def send_news_feed(unknown):
@@ -78,6 +103,7 @@ def send_news_feed(unknown):
         -q, --query: The news to look for (default: "")
         -t, --token: Telegram bot token
         -I, --id: Telegram Chat id
+            --fmp: Financial Modeling Prop Api Key
         -i, --interval: Interval in minutes to fetch news (default: 15)
 
     Note:
@@ -101,6 +127,9 @@ def send_news_feed(unknown):
         help="Telegram bot token",
     )
     parser.add_argument("-I", "--id", type=str, required=True, help="Telegram Chat id")
+    parser.add_argument(
+        "--fmp", type=str, default="", help="Financial Modeling Prop Api Key"
+    )
     parser.add_argument(
         "-i",
         "--interval",
@@ -112,19 +141,33 @@ def send_news_feed(unknown):
 
     nltk.download("punkt", quiet=True)
     news = FinancialNews()
-    logger.info(
-        f"Starting the News Feed on {args.interval} minutes"
-    )
+    logger.info(f"Starting the News Feed on {args.interval} minutes")
     while True:
         try:
-            articles = news.get_coindesk_news(query=args.query)
-            if len(articles) == 0:
-                time.sleep(args.interval * 60)
-                continue
-            asyncio.run(send_articles(articles, args.token, args.id))
+            fmp_articles = []
+            coindesk_articles = news.get_coindesk_news(query=args.query)
+            if args.fmp:
+                start = datetime.now() - timedelta(minutes=args.interval)
+                start = start.strftime("%Y-%m-%d %H:%M:%S")
+                end = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+                fmp_articles = news.get_fmp_news(api=args.fmp).get_latest_articles(
+                    save=True, start=start, end=end
+                )
+            if len(coindesk_articles) != 0:
+                asyncio.run(
+                    send_articles(
+                        coindesk_articles,
+                        args.token,
+                        args.id,
+                        "coindesk",
+                        interval=args.interval,
+                    )
+                )
+            if len(fmp_articles) != 0:
+                asyncio.run(send_articles(fmp_articles, args.token, args.id, "fmp"))
             time.sleep(args.interval * 60)
         except KeyboardInterrupt:
             logger.info("Stopping the News Feed ...")
-            exit(0)
+            sys.exit(0)
         except Exception as e:
             logger.error(e)

{bbstrader-0.3.2 → bbstrader-0.3.3}/bbstrader/metatrader/account.py

@@ -5,8 +5,6 @@ from datetime import datetime, timedelta
 from typing import Any, Dict, List, Literal, Optional, Tuple, Union
 
 import pandas as pd
-from currency_converter import SINGLE_DAY_ECB_URL, CurrencyConverter
-
 from bbstrader.metatrader.utils import (
     AccountInfo,
     BookInfo,
@@ -23,6 +21,7 @@ from bbstrader.metatrader.utils import (
     TradeRequest,
     raise_mt5_error,
 )
+from currency_converter import SINGLE_DAY_ECB_URL, CurrencyConverter
 
 try:
     import MetaTrader5 as mt5
@@ -33,6 +32,7 @@ except ImportError:
 __all__ = [
     "Account",
     "Broker",
+    "MetaQuotes",
     "AdmiralMarktsGroup",
     "JustGlobalMarkets",
     "PepperstoneGroupLimited",
@@ -41,6 +41,7 @@ __all__ = [
 ]
 
 __BROKERS__ = {
+    "MQL": "MetaQuotes Ltd.",
     "AMG": "Admirals Group AS",
     "JGM": "Just Global Markets Ltd.",
     "FTMO": "FTMO S.R.O.",
@@ -67,14 +68,13 @@ _ADMIRAL_MARKETS_PRODUCTS_ = [
 ]
 _JUST_MARKETS_PRODUCTS_ = ["Stocks", "Crypto", "indices", "Commodities", "Forex"]
 
-SUPPORTED_BROKERS = [__BROKERS__[b] for b in {"AMG", "JGM", "FTMO"}]
+SUPPORTED_BROKERS = [__BROKERS__[b] for b in {"MQL", "AMG", "JGM", "FTMO"}]
 INIT_MSG = (
-    f"\n* Ensure you have a good and stable internet connexion\n"
-    f"* Ensure you have an activete MT5 terminal install on your machine\n"
-    f"* Ensure you have an active MT5 Account with {' or '.join(SUPPORTED_BROKERS)}\n"
-    f"* If you want to trade {', '.join(_ADMIRAL_MARKETS_PRODUCTS_)}, See [{_ADMIRAL_MARKETS_URL_}]\n"
-    f"* If you want to trade {', '.join(_JUST_MARKETS_PRODUCTS_)}, See [{_JUST_MARKETS_URL_}]\n"
-    f"* If you are looking for a prop firm, See [{_FTMO_URL_}]\n"
+    f"\n* Check your internet connection\n"
+    f"* Make sure MT5 is installed and active\n"
+    f"* Looking for a boker? See [{_ADMIRAL_MARKETS_URL_}] "
+    f"or [{_JUST_MARKETS_URL_}]\n"
+    f"* Looking for a prop firm? See [{_FTMO_URL_}]\n"
 )
 
 amg_url = _ADMIRAL_MARKETS_URL_
@@ -136,7 +136,16 @@ AMG_EXCHANGES = {
 }
 
 
-def check_mt5_connection(**kwargs) -> bool:
+def check_mt5_connection(
+    *,
+    path=None,
+    login=None,
+    password=None,
+    server=None,
+    timeout=60_000,
+    portable=False,
+    **kwargs,
+) -> bool:
     """
     Initialize the connection to the MetaTrader 5 terminal.
 
@@ -156,13 +165,12 @@ def check_mt5_connection(**kwargs) -> bool:
         - Follow these instructions to lunch each terminal in portable mode first:
             https://www.metatrader5.com/en/terminal/help/start_advanced/start#configuration_file
     """
-    path = kwargs.get("path", None)
-    login = kwargs.get("login", None)
-    password = kwargs.get("password", None)
-    server = kwargs.get("server", None)
-    timeout = kwargs.get("timeout", 60_000)
-    portable = kwargs.get("portable", False)
-
+    if login is not None and server is not None:
+        account_info = mt5.account_info()
+        if account_info is not None:
+            if account_info.login == login and account_info.server == server:
+                return True
+        
     init = False
     if path is None and (login or password or server):
         raise ValueError(
@@ -221,6 +229,11 @@ class Broker(object):
         return f"{self.__class__.__name__}({self.name})"
 
 
+class MetaQuotes(Broker):
+    def __init__(self, **kwargs):
+        super().__init__(__BROKERS__["MQL"], **kwargs)
+
+
 class AdmiralMarktsGroup(Broker):
     def __init__(self, **kwargs):
         super().__init__(__BROKERS__["AMG"], **kwargs)
@@ -262,6 +275,7 @@ class AMP(Broker): ...
 
 BROKERS: Dict[str, Broker] = {
     "FTMO": FTMO(),
+    "MQL": MetaQuotes(),
     "AMG": AdmiralMarktsGroup(),
     "JGM": JustGlobalMarkets(),
     "PGL": PepperstoneGroupLimited(),
@@ -1372,7 +1386,7 @@ class Account(object):
         group: Optional[str] = None,
         ticket: Optional[int] = None,
         to_df: bool = False,
-    ) -> Union[pd.DataFrame, Tuple[TradeOrder], None]:
+    ) -> Union[pd.DataFrame, Tuple[TradeOrder]]:
         """
         Get active orders with the ability to filter by symbol or ticket.
         There are four call options: