Merge pull request #4105 from OpenBB-finance/release/2.3.1

Release/2.3.1

.github/workflows/gh-pages.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - release/*
 
 jobs:
   generate:
@@ -64,6 +65,7 @@ jobs:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
+        if: startsWith(github.ref, 'refs/heads/main')
         with:
           github_token: ${{ secrets.DEPLOY_TOKEN }}
           publish_dir: ./website/build

build/docker/compose.env

@@ -1,2 +1,2 @@
 OPENBBTERMINAL_DOCKER_REGISTRY="ghcr.io"
-OPENBBTERMINAL_DOCKER_RELEASE_VERSION="2.3.0"
+OPENBBTERMINAL_DOCKER_RELEASE_VERSION="2.3.1"

build/docker/docker-compose.yaml

@@ -7,6 +7,6 @@ services:
       - ~/OpenBBUserData:/home/python/OpenBBUserData
       - ~/.openbb_terminal:/home/python/.openbb_terminal
     platform: linux/amd64
-    image: ghcr.io/openbb-finance/openbbterminal/openbb:2.3.0
+    image: ghcr.io/openbb-finance/openbbterminal/openbb:2.3.1
     stdin_open: true # docker run -i
     tty: true # docker run -t

build/nsis/setup.nsi

@@ -10,7 +10,7 @@
   !define NAME "OpenBB Terminal"
   !define COMPANY "OpenBB"
   !define APPFILE "OpenBBTerminal.exe"
-  !define VERSION "2.3.0"
+  !define VERSION "2.3.1"
   !define SLUG "${NAME} v${VERSION}"
 
 ;--------------------------------

build/pyinstaller/.env

@@ -1,5 +1,5 @@
 OPENBB_LOGGING_APP_NAME=gst_packaged
-OPENBB_LOGGING_COMMIT_HASH=sha:7939b37
+OPENBB_LOGGING_COMMIT_HASH=sha:dbd2097
 OPENBB_ENABLE_PREDICT=false
 OPENBB_ENABLE_CHECK_API=true
 OPENBB_ENABLE_THOUGHTS_DAY=false

openbb_terminal/common/behavioural_analysis/reddit_model.py

@@ -528,7 +528,6 @@ def get_spac(
 
     try:
         for submission in submissions:
-
             # Get more information about post using PRAW api
             submission = praw_api.submission(id=submission.id)
 
@@ -814,13 +813,11 @@ def get_due_dilligence(
 
             # Ensure that the post hasn't been removed in the meanwhile
             if not submission.removed_by_category:
-
                 # Either just filter out Yolo, and Meme flairs, or focus on DD, based on b_DD flag
                 if (
                     submission.link_flair_text in l_flair_text,
                     submission.link_flair_text not in ["Yolo", "Meme"],
                 )[show_all_flairs]:
-
                     s_datetime = datetime.utcfromtimestamp(
                         submission.created_utc
                     ).strftime("%Y-%m-%d %H:%M:%S")

openbb_terminal/common/quantitative_analysis/qa_model.py

@@ -277,7 +277,6 @@ def get_var(
     std = data_return.std(axis=0)
 
     if adjusted_var:
-
         # Kurtosis
         # Measures height and sharpness of the central peak relative to that of a standard bell curve
         k = data_return.kurtosis(axis=0)

openbb_terminal/core/integration_tests/integration_controller.py

@@ -125,7 +125,6 @@ def convert_list_to_test_files(path_list: List[str]) -> List[Path]:
     test_files = []
 
     for path in path_list:
-
         if path.startswith(
             str(Path("openbb_terminal", "core", "integration_tests", "scripts"))
         ):
@@ -377,7 +376,6 @@ def run_test_files(
     fails: Dict[str, Dict[str, Any]] = {}
 
     if test_files:
-
         n = len(test_files)
 
         start = time.time()
@@ -407,7 +405,6 @@ def run_test_files(
                 style="bold",
             )
             with Pool(processes=subprocesses) as pool:
-
                 # Choosing chunksize: line 477 .../lib/python3.9/multiprocessing/pool.py
                 chunksize, extra = divmod(n, subprocesses * 4)
                 if extra:
@@ -424,7 +421,6 @@ def run_test_files(
                         chunksize=chunksize,
                     )
                 ):
-
                     file_short_name, exception = result
                     if exception:
                         n_failures += 1
@@ -501,7 +497,6 @@ def display_summary(
         console.print("\n" + to_section_title("integration test summary"))
 
         for file, exception in fails.items():
-
             # Assuming the broken command is the last one called in the traceback
             broken_cmd = "unknown"
             frame: FrameSummary

openbb_terminal/core/library/operation.py

@@ -115,7 +115,6 @@ def about(self):
 
 
 class OperationLogger:
-
     last_method: Dict[Any, Any] = {}
 
     def __init__(
@@ -231,7 +230,6 @@ def __remove_key_and_log_state(func_module: str, function_args: dict) -> dict:
         """
 
         if func_module == "openbb_terminal.keys_model":
-
             from openbb_terminal.core.log.generation.settings_logger import (  # pylint: disable=C0415
                 log_keys,
             )

openbb_terminal/core/log/generation/settings_logger.py

@@ -108,7 +108,6 @@ def log_keys() -> None:
     current_keys = {}
 
     for cfg_var_name in var_list:
-
         cfg_var_value = getattr(cfg, cfg_var_name)
 
         if cfg_var_value != "REPLACE_ME":

openbb_terminal/cryptocurrency/crypto_models.py

@@ -64,7 +64,6 @@ def find(
 
 
 def _find_CoinGecko(key: str, query: str, limit: int) -> pd.DataFrame:
-
     # pylint: disable=C0415
     from openbb_terminal.cryptocurrency.discovery.pycoingecko_model import (
         get_coin_list,
@@ -85,7 +84,6 @@ def _find_CoinGecko(key: str, query: str, limit: int) -> pd.DataFrame:
 
 
 def _find_CoinPaprika(key: str, query: str, limit: int) -> pd.DataFrame:
-
     # pylint: disable=C0415
     from openbb_terminal.cryptocurrency.due_diligence.coinpaprika_model import (
         get_coin_list,
@@ -107,7 +105,6 @@ def _find_CoinPaprika(key: str, query: str, limit: int) -> pd.DataFrame:
 
 
 def _find_Binance(key: str, query: str, limit: int) -> pd.DataFrame:
-
     # pylint: disable=C0415
     from openbb_terminal.cryptocurrency.discovery.pycoingecko_model import (
         get_coin_list,
@@ -134,7 +131,6 @@ def _find_Binance(key: str, query: str, limit: int) -> pd.DataFrame:
 
 
 def _find_Coinbase(key: str, query: str, limit: int) -> pd.DataFrame:
-
     # pylint: disable=C0415
     from openbb_terminal.cryptocurrency.discovery.pycoingecko_model import (
         get_coin_list,

openbb_terminal/cryptocurrency/cryptocurrency_helpers.py

@@ -696,7 +696,6 @@ def display_all_coins(
         df.drop("index", axis=1, inplace=True)
 
     else:
-
         if source == "CoinGecko":
             coins_df = pycoingecko_model.get_coin_list().drop("index", axis=1)
             df = _create_closest_match_df(symbol.lower(), coins_df, limit, cutoff)

openbb_terminal/cryptocurrency/dataframe_helpers.py

@@ -125,7 +125,6 @@ def lambda_very_long_number_formatter(num: Union[str, int, float]) -> str:
 
 
 def prettify_paragraph(text):
-
     # Add tab to the beginning of paragraph
     text = "\t" + text
     pat = "(?<!\n)\n(?!\n)"

openbb_terminal/cryptocurrency/discovery/pycoingecko_model.py

@@ -131,7 +131,6 @@ def get_coins(
     sortby: str = "Symbol",
     ascend: bool = False,
 ) -> pd.DataFrame:
-
     """Get N coins from CoinGecko [Source: CoinGecko]
 
     Parameters
@@ -248,7 +247,6 @@ def get_gainers_or_losers(
     )
 
     if sortby in GAINERS_LOSERS_COLUMNS:
-
         sorted_df = sorted_df[
             (sorted_df["Volume [$]"].notna()) & (sorted_df["Market Cap"].notna())
         ]

openbb_terminal/cryptocurrency/discovery/pycoingecko_view.py

@@ -124,7 +124,6 @@ def display_gainers(
     df = pycoingecko_model.get_gainers(limit=limit, interval=interval, sortby=sortby)
 
     if not df.empty:
-
         for col in ["Volume [$]", "Market Cap"]:
             if col in df.columns:
                 df[col] = df[col].apply(lambda x: lambda_very_long_number_formatter(x))
@@ -172,7 +171,6 @@ def display_losers(
     df = pycoingecko_model.get_losers(limit=limit, interval=interval, sortby=sortby)
 
     if not df.empty:
-
         for col in ["Volume [$]", "Market Cap"]:
             if col in df.columns:
                 df[col] = df[col].apply(lambda x: lambda_very_long_number_formatter(x))

openbb_terminal/cryptocurrency/due_diligence/binance_view.py

@@ -89,7 +89,7 @@ def display_balance(
         return
 
     total = np.sum(df["Amount"])
-    console.print(f"\nYou currently have {total} coins and the breakdown is:")
+    console.print(f"You currently have {total} coins and the breakdown is:\n")
 
     print_rich_table(
         df, headers=df.columns, show_index=True, title="Account Holdings for Assets"

openbb_terminal/cryptocurrency/due_diligence/coinglass_view.py

@@ -128,7 +128,6 @@ def plot_data(
     ylabel: str = "",
     external_axes: Optional[List[plt.Axes]] = None,
 ):
-
     # This plot has 2 axes
     if not external_axes:
         _, axes = plt.subplots(
@@ -180,7 +179,6 @@ def plot_data_bar(
     ylabel: str = "",
     external_axes: Optional[List[plt.Axes]] = None,
 ):
-
     # This plot has 2 axes
     if not external_axes:
         _, axes = plt.subplots(

openbb_terminal/cryptocurrency/due_diligence/glassnode_model.py

@@ -512,7 +512,6 @@ def get_exchange_balances(
     )  # get price TODO: grab data from loaded symbol
 
     if r1.status_code == 200 and r2.status_code == 200 and r3.status_code == 200:
-
         df1 = pd.DataFrame(json.loads(r1.text))
         df1.set_index("t", inplace=True)
         df1.rename(columns={"v": "stacked"}, inplace=True)

openbb_terminal/cryptocurrency/due_diligence/messari_view.py

@@ -222,7 +222,6 @@ def display_marketcap_dominance(
     )
 
     if not df.empty:
-
         # This plot has 1 axis
         if not external_axes:
             _, ax = plt.subplots(figsize=plot_autoscale(), dpi=cfgPlot.PLOT_DPI)

openbb_terminal/cryptocurrency/due_diligence/santiment_model.py

@@ -85,7 +85,6 @@ def get_github_activity(
     df = pd.DataFrame()
 
     if response.status_code == 200:
-
         if "getMetric" in response.json()["data"]:
             df = pd.DataFrame(response.json()["data"]["getMetric"]["timeseriesData"])
             df["datetime"] = pd.to_datetime(df["datetime"])

openbb_terminal/cryptocurrency/onchain/bitquery_view.py

@@ -264,7 +264,6 @@ def display_ethereum_unique_senders(
 
     df = bitquery_model.get_ethereum_unique_senders(interval, limit, sortby, ascend)
     if not df.empty:
-
         column_names = ["uniqueSenders", "transactions", "maximumGasPrice"]
         column_names = prettify_column_names(column_names)
 
@@ -391,7 +390,6 @@ def display_spread_for_crypto_pair(
         symbol=symbol, to_symbol=to_symbol, limit=limit, sortby=sortby, ascend=ascend
     )
     if not df.empty:
-
         print_rich_table(
             df,
             headers=list(df.columns),

openbb_terminal/cryptocurrency/onchain/blockchain_model.py

@@ -126,7 +126,6 @@ def get_btc_single_block(blockhash: str) -> pd.DataFrame:
     data = _blockchain_data_api_make_request(f"rawblock/{blockhash}?format=json")
 
     if data:
-
         df = pd.json_normalize(data)
         return df
 

openbb_terminal/cryptocurrency/onchain/shroom_model.py

@@ -175,7 +175,6 @@ def get_total_value_locked(
     symbol: str = "USDC",
     interval: int = 1,
 ) -> pd.DataFrame:
-
     """
     Get total value locked for a user/name address and symbol
     TVL measures the total amount of a token that is locked in a contract.

openbb_terminal/cryptocurrency/onchain/shroom_view.py

@@ -162,7 +162,6 @@ def display_total_value_locked(
     sheet_name: str = None,
     external_axes: Optional[List[plt.Axes]] = None,
 ) -> None:
-
     """
     Get total value locked for a certain address
     TVL measures the total amount of a token that is locked in a contract.

openbb_terminal/cryptocurrency/overview/blockchaincenter_view.py

@@ -60,7 +60,6 @@ def display_altcoin_index(
         if df.empty:
             console.print("\nError scraping blockchain central\n")
         else:
-
             # This plot has 1 axis
             if not external_axes:
                 _, ax = plt.subplots(figsize=plot_autoscale(), dpi=PLOT_DPI)

openbb_terminal/cryptocurrency/overview/loanscan_view.py

@@ -71,7 +71,6 @@ def display_crypto_rates(
         colors = iter(cfg.theme.get_colors(reverse=True))
 
         for asset in assets:
-
             width = df_non_null.loc[(df_non_null.variable == asset)]
             # silence Setcopywarnings
             pd.options.mode.chained_assignment = None

openbb_terminal/cryptocurrency/overview/overview_controller.py

@@ -348,7 +348,6 @@ def call_btcrb(self, other_args: List[str]):
             parser, other_args, EXPORT_BOTH_RAW_DATA_AND_FIGURES
         )
         if ns_parser:
-
             display_btc_rainbow(
                 start_date=ns_parser.since.strftime("%Y-%m-%d"),
                 end_date=ns_parser.until.strftime("%Y-%m-%d"),

openbb_terminal/cryptocurrency/overview/pycoingecko_view.py

@@ -382,7 +382,6 @@ def display_stablecoins(
     df = gecko.get_stable_coins(limit, sortby=sortby, ascend=ascend)
 
     if not df.empty:
-
         total_market_cap = int(df["Market_Cap_[$]"].sum())
         df.columns = df.columns.str.replace("_", " ")
 
@@ -532,7 +531,6 @@ def display_exchanges(
     df = gecko.get_exchanges(sortby, ascend)
 
     if not df.empty:
-
         if links is True:
             df = df[["Rank", "Name", "Url"]]
         else:
@@ -709,7 +707,6 @@ def display_derivatives(
     df = gecko.get_derivatives(sortby=sortby, ascend=ascend)
 
     if not df.empty:
-
         print_rich_table(
             df.head(limit),
             headers=list(df.columns),

openbb_terminal/custom_prompt_toolkit.py

@@ -52,7 +52,6 @@ def __init__(
         match_middle: bool = False,
         pattern: Optional[Pattern[str]] = None,
     ) -> None:
-
         assert not (WORD and sentence)  # noqa: S101
 
         self.words = words
@@ -131,7 +130,6 @@ class NestedCompleter(Completer):
     def __init__(
         self, options: Dict[str, Optional[Completer]], ignore_case: bool = True
     ) -> None:
-
         self.flags_processed: List = list()
         self.original_options = options
         self.options = options

openbb_terminal/dashboards/stream/forecast.py

@@ -231,7 +231,6 @@ def on_ticker_change(self):
         ]
 
     def run(self):
-
         st.title("OpenBB Forecasting")  # Title does not like being in a column
 
         r1c1, r1c2, r1c3, r1c4, r1c5 = st.columns([2, 1, 1, 1, 1])

openbb_terminal/decorators.py

@@ -32,7 +32,6 @@ def log_start_end(func=None, log=None):
     def decorator(func):
         @functools.wraps(func)
         def wrapper(*args, **kwargs):
-
             logging_name = ""
 
             args_passed_in_function = [