Feature: Ultima Insights NewsMonitor Integration

openbb_terminal/common/feedparser_model.py

@@ -13,7 +13,11 @@
 
 
 def get_news(
-    term: str = "", sources: str = "", sort: str = "published", limit: int = 10
+    term: str = "",
+    sources: str = "",
+    sort: str = "published",
+    limit: int = 10,
+    display_message: bool = True,
 ) -> pd.DataFrame:
     """Get news for a given term and source. [Source: Feedparser]
 
@@ -27,6 +31,8 @@ def get_news(
         the column to sort by
     limit : int
         number of articles to display
+    display_message: bool
+        whether to display a message to the user
 
     Returns
     -------
@@ -45,6 +51,8 @@ def get_news(
     os.environ["SSL_CERT_FILE"] = certifi.where()
 
     have_data = False
+    if display_message:
+        console.print("[yellow]Fetching data. Please be patient\n[/yellow]")
     n = 0
 
     while not have_data:
@@ -68,7 +76,7 @@ def get_news(
             elif n == 60:  # Breaking if 60 successful requests return no data
                 console.print("[red]Timeout occurred. Please try again\n[/red]")
                 break
-            n = n + 1
+            n += 1
 
         elif hasattr(data, "status") and data.status != 200:  # If data request failed
             console.print("[red]Status code not 200. Unable to retrieve data\n[/red]")

openbb_terminal/common/ultima_newsmonitor_model.py

@@ -0,0 +1,171 @@
+""" Ultima Insights News Monitor Model """
+__docformat__ = "numpy"
+
+import logging
+import os
+from urllib.parse import quote
+
+import certifi
+import pandas as pd
+
+from openbb_terminal.core.session.current_user import get_current_user
+from openbb_terminal.decorators import check_api_key, log_start_end
+from openbb_terminal.helper_funcs import request
+from openbb_terminal.rich_config import console
+
+logger = logging.getLogger(__name__)
+
+
+base_url = "https://api.ultimainsights.ai/v1"
+
+
+@log_start_end(log=logger)
+@check_api_key(["API_ULTIMAINSIGHTS_KEY"])
+def get_news(term: str = "", sort: str = "articlePublishedDate") -> pd.DataFrame:
+    """Get news for a given term and source. [Source: Ultima Insights News Monitor]
+
+    Parameters
+    ----------
+    term : str
+        term to search on the news articles
+    sort: str
+        the column to sort by
+
+    Returns
+    -------
+    articles: pd.DataFrame
+        term to search on the news articles
+
+    Examples
+    --------
+    >>> from openbb_terminal.sdk import openbb
+    >>> openbb.news()
+    """
+    # Necessary for installer so that it can locate the correct certificates for
+    # API calls and https
+    # https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error/73270162#73270162
+    os.environ["REQUESTS_CA_BUNDLE"] = certifi.where()
+    os.environ["SSL_CERT_FILE"] = certifi.where()
+
+    current_user = get_current_user()
+    auth_header = {
+        "Authorization": f"Bearer {current_user.credentials.API_ULTIMAINSIGHTS_KEY}"
+    }
+
+    have_data = False
+    limit = 0
+
+    while not have_data:
+        if term:
+            term = quote(term)
+            term = term.upper()
+            term = term.strip()
+            if term in supported_terms():
+                data = request(
+                    f"{base_url}/getNewsArticles/{term}", headers=auth_header
+                )
+            else:
+                console.print(
+                    "[red]Ticker not supported. Unable to retrieve data\n[/red]"
+                )
+                return pd.DataFrame()
+        else:
+            console.print("[red]No term specified. Unable to retrieve data\n[/red]")
+            return pd.DataFrame()
+
+        if (
+            hasattr(data, "status") and data.status_code == 200
+        ):  # Checking if data has status attribute and if data request succeeded
+            if data.content:
+                have_data = True
+            elif limit == 60:  # Breaking if 60 successful requests return no data
+                console.print("[red]Timeout occurred. Please try again\n[/red]")
+                break
+            limit = limit + 1
+
+        elif (
+            hasattr(data, "status") and data.status_code != 200
+        ):  # If data request failed
+            console.print("[red]Status code not 200. Unable to retrieve data\n[/red]")
+            break
+        else:
+            # console.print("[red]Could not retrieve data\n[/red]")
+            break
+    if not data.json():
+        return pd.DataFrame()
+    df = pd.DataFrame(
+        data.json(),
+        columns=[
+            "articleHeadline",
+            "articleURL",
+            "articlePublishedDate",
+            "riskCategory",
+            "riskElaboratedDescription",
+            "relevancyScore",
+        ],
+    )
+    df = df[df["relevancyScore"] < 5]
+    df = df[df["relevancyScore"] > 3.5]
+    df["riskElaboratedDescription"] = df["riskElaboratedDescription"].str.replace(
+        "\n", ""
+    )
+    df["riskElaboratedDescription"] = df["riskElaboratedDescription"].str.replace(
+        "\n", ""
+    )
+    df["articlePublishedDate"] = pd.to_datetime(df["articlePublishedDate"])
+    df = df.sort_values(by=[sort], ascending=False)
+    return df
+
+
+@log_start_end(log=logger)
+def supported_terms() -> list:
+    """Get supported terms for news. [Source: Ultima Insights]
+
+    Returns
+    -------
+    terms: list
+        list of supported terms (tickers)
+
+    """
+
+    # Necessary for installer so that it can locate the correct certificates for
+    # API calls and https
+    # https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error/73270162#73270162
+    os.environ["REQUESTS_CA_BUNDLE"] = certifi.where()
+    os.environ["SSL_CERT_FILE"] = certifi.where()
+    data = request(f"{base_url}/supportedTickers")
+    return list(data.json())
+
+
+@log_start_end(log=logger)
+@check_api_key(["API_ULTIMAINSIGHTS_KEY"])
+def get_company_info(ticker: str) -> dict:
+    """Get company info for a given ticker. [Source: Ultima Insights]
+
+    Parameters
+    ----------
+    ticker : str
+        ticker to search for company info
+
+    Returns
+    -------
+    company_info: dict
+        dictionary of company info
+    """
+
+    # Necessary for installer so that it can locate the correct certificates for
+    # API calls and https
+    # https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error/73270162#73270162
+    os.environ["REQUESTS_CA_BUNDLE"] = certifi.where()
+    os.environ["SSL_CERT_FILE"] = certifi.where()
+
+    current_user = get_current_user()
+    auth_header = {
+        "Authorization": f"Bearer {current_user.credentials.API_ULTIMAINSIGHTS_KEY}"
+    }
+
+    if ticker in supported_terms():
+        data = request(f"{base_url}/getCompanyInfo/{ticker}", headers=auth_header)
+        return data.json()
+    console.print("[red]Ticker not supported. Unable to retrieve data\n[/red]")
+    return {}

openbb_terminal/common/ultima_newsmonitor_view.py

@@ -0,0 +1,106 @@
+""" News View """
+__docformat__ = "numpy"
+
+import logging
+import os
+from typing import Optional
+
+import pandas as pd
+
+from openbb_terminal.common import feedparser_model, ultima_newsmonitor_model
+from openbb_terminal.decorators import log_start_end
+from openbb_terminal.helper_funcs import export_data
+from openbb_terminal.rich_config import console
+
+logger = logging.getLogger(__name__)
+
+
+@log_start_end(log=logger)
+def display_news(
+    term: str,
+    sources: str = "",
+    limit: int = 5,
+    export: str = "",
+    sheet_name: Optional[str] = None,
+    sort: str = "articlePublishedDate",
+):
+    """Plots news for a given term and source. [Source: Ultima Insights]
+
+    Parameters
+    ----------
+    term : str
+        term to search on the news articles
+    sources : str
+        sources to exclusively show news from
+    limit : int
+        number of articles to display
+    export : str
+        Export dataframe data to csv,json,xlsx file
+    sort: str
+        the column to sort by
+    """
+    console.print()
+    if term not in ultima_newsmonitor_model.supported_terms():
+        console.print(f"[red]Unsupported ticker: {term}[/red]")
+        return
+    company_info = ultima_newsmonitor_model.get_company_info(term)
+    company_name = company_info.get("companyShortName", term)
+    # TODO: calling them all together does not work with feedparser
+    bbg = feedparser_model.get_news(
+        company_name, sources="bloomberg", sort="published", display_message=False
+    )
+    wsj = feedparser_model.get_news(
+        company_name, sources="wsj", sort="published", display_message=False
+    )
+    reuters = feedparser_model.get_news(
+        company_name, sources="reuters", sort="published", display_message=False
+    )
+    cnbc = feedparser_model.get_news(
+        company_name, sources="cnbc", sort="published", display_message=False
+    )
+    breaking_news = pd.concat([bbg, wsj, reuters, cnbc])
+    if len(breaking_news) > 0:
+        breaking_news = breaking_news.sort_values(by="Date", ascending=False)
+        breaking_news["DateNorm"] = (
+            pd.to_datetime(breaking_news["Date"]).dt.tz_convert(None).dt.normalize()
+        )
+        today = pd.to_datetime("today").normalize()
+        breaking_news = breaking_news[breaking_news["DateNorm"] == today]
+        if len(breaking_news) > 0:
+            console.print(
+                "Uncategorized Breaking News (Bloomberg, Reuters, WSJ, CNBC):"
+            )
+            for _, row in breaking_news.head(limit).iterrows():
+                console.print(f"> {row['Date']} - {row['Description']}")
+                console.print(row["URL"] + "\n")
+            console.print("------------------------")
+
+    articles = ultima_newsmonitor_model.get_news(term, sort)
+    articles = articles.head(limit).sort_values(by="relevancyScore", ascending=False)
+    # console.print(f"News Powered by [purple]ULTIMA INSIGHTS[/purple].\nFor more info: https://www.ultimainsights.ai\n")
+    for _, row in articles.iterrows():
+        console.print(
+            f"> {row['articlePublishedDate']} - {row['articleHeadline']} -> [green]{row['riskCategory']}[/green] "
+            f"(\x1B[3m{row['riskElaboratedDescription']}\x1B[0m) -> "
+            f"[purple]relevancy score: {round(row['relevancyScore'], 2) if row['relevancyScore'] < 5 else 5}"
+            f"/5 Stars[/purple]"
+        )
+        console.print(row["articleURL"] + "\n")
+    console.print(
+        "[red]To report any issues, please visit https://beta.ultimainsights.ai/my-account/support[/red]\n"
+    )
+    console.print()
+
+    export_data(
+        export,
+        os.path.dirname(os.path.abspath(__file__)),
+        f"news_{'_'.join(term)}_{'_'.join(sources)}",
+        articles,
+        sheet_name,
+    )
+
+
+@log_start_end(log=logger)
+def supported_terms() -> list:
+    """Returns supported terms for news"""
+    return ultima_newsmonitor_model.supported_terms()

openbb_terminal/core/sdk/controllers/stocks_sdk_controller.py

@@ -24,6 +24,7 @@ class StocksController(model.StocksRoot):
     Attributes:
         `candle`: Show candle plot of loaded ticker.\n
         `load`: Load a symbol to perform analysis using the string above as a template.\n
+        `news`: Get news for a given term and source. [Source: Feedparser]\n
         `process_candle`: Process DataFrame into candle style plot.\n
         `quote`: Gets ticker quote from FMP\n
         `search`: Search selected query for tickers.\n

openbb_terminal/core/sdk/models/keys_sdk_model.py

@@ -42,6 +42,7 @@ class KeysRoot(Category):
         `tokenterminal`: Set Token Terminal key.\n
         `tradier`: Set Tradier key\n
         `twitter`: Set Twitter key\n
+        `ultimainsights`: Set Ultima Insights key\n
         `walert`: Set Walert key\n
     """
 
@@ -82,4 +83,5 @@ def __init__(self):
         self.tokenterminal = lib.keys_model.set_tokenterminal_key
         self.tradier = lib.keys_model.set_tradier_key
         self.twitter = lib.keys_model.set_twitter_key
+        self.ultimainsights = lib.keys_model.set_ultimainsights_key
         self.walert = lib.keys_model.set_walert_key

openbb_terminal/core/sdk/models/stocks_sdk_model.py

@@ -11,6 +11,7 @@ class StocksRoot(Category):
     Attributes:
         `candle`: Show candle plot of loaded ticker.\n
         `load`: Load a symbol to perform analysis using the string above as a template.\n
+        `news`: Get news for a given term and source. [Source: Feedparser]\n
         `process_candle`: Process DataFrame into candle style plot.\n
         `quote`: Gets ticker quote from FMP\n
         `search`: Search selected query for tickers.\n
@@ -23,6 +24,7 @@ def __init__(self):
         super().__init__()
         self.candle = lib.stocks_helper.display_candle
         self.load = lib.stocks_helper.load
+        self.news = lib.common_ultima_newsmonitor_model.get_news
         self.process_candle = lib.stocks_helper.process_candle
         self.quote = lib.stocks_model.get_quote
         self.search = lib.stocks_helper.search

openbb_terminal/core/sdk/sdk_init.py

@@ -46,6 +46,8 @@
     common_model,
     feedparser_model as common_feedparser_model,
     feedparser_view as common_feedparser_view,
+    ultima_newsmonitor_model as common_ultima_newsmonitor_model,
+    ultima_newsmonitor_view as common_ultima_newsmonitor_view,
     newsapi_model as common_newsapi_model,
     newsapi_view as common_newsapi_view,
 )

openbb_terminal/core/sdk/trail_map.csv

@@ -310,10 +310,11 @@ keys.stocksera,keys_model.set_stocksera_key,
 keys.tokenterminal,keys_model.set_tokenterminal_key,
 keys.tradier,keys_model.set_tradier_key,
 keys.twitter,keys_model.set_twitter_key,
+keys.ultimainsights,keys_model.set_ultimainsights_key,
 keys.walert,keys_model.set_walert_key,
 login,sdk_session.login,
 logout,sdk_session.logout,
-news,common_feedparser_model.get_news,
+news,common_ultima_newsmonitor_model.get_news,
 portfolio.alloc.assets,portfolio_model.get_assets_allocation,
 portfolio.alloc.countries,portfolio_model.get_countries_allocation,
 portfolio.alloc.regions,portfolio_model.get_regions_allocation,
@@ -524,6 +525,7 @@ stocks.options.unu,stocks_options_fdscanner_model.unusual_options,stocks_options
 stocks.options.voi,stocks_options_view.plot_voi,
 stocks.options.vol,stocks_options_view.plot_vol,
 stocks.options.vsurf,stocks_options_yfinance_model.get_iv_surface,stocks_options_yfinance_view.display_vol_surface
+stocks.news,common_ultima_newsmonitor_model.get_news,
 stocks.process_candle,stocks_helper.process_candle,
 stocks.qa.beta,stocks_qa_beta_model.beta_model,stocks_qa_beta_view.beta_view
 stocks.qa.capm,stocks_qa_factors_model.capm_information,