hotfix/deprecate-options-screener: Sunsets deprecated Options screener (

#5111)

* Sunsets deprecated Options screener

* mypy

* docstring fix

* one more docstrings fix

* missed i18n.yaml artifacts

* pylint

* fix test

openbb_terminal/core/sdk/controllers/stocks_sdk_controller.py

@@ -256,18 +256,15 @@ def ins(self):
     def options(self):
         """Stocks Options Submodule
 
-        Submodules:
-            `screen`: Screen Module
-
         Attributes:
             `chains`: Get Option Chain For A Stock.  No greek data is returned\n
             `dte`: Returns a new column containing the DTE as an integer, including 0.\n
             `eodchain`: Get full EOD option date across all expirations\n
             `expirations`: Get Option Chain Expirations\n
             `generate_data`: Gets x values, and y values before and after premiums\n
             `greeks`: Gets the greeks for a given option\n
-            `grhist`: Get histoical option greeks\n
-            `grhist_chart`: Plots historical greeks for a given option. [Source: Syncretism]\n
+            `grhist`: Get historical EOD option prices, with Greeks, for a given OCC chain label.\n
+            `grhist_chart`: Plots historical greeks for a given option.\n
             `hist`: Get historical option pricing.\n
             `info`: Scrape barchart for options info\n
             `info_chart`: Scrapes Barchart.com for the options information\n

openbb_terminal/core/sdk/models/econometrics_sdk_model.py

@@ -39,7 +39,7 @@ class EconometricsRoot(Category):
         `re`: The random effects model is virtually identical to the pooled OLS model except that is accounts for the\n
         `root`: Calculate test statistics for unit roots\n
         `root_chart`: Determine the normality of a timeseries.\n
-        `vif`: Determine the vif, which tests for collinearity.\n
+        `vif`: Calculates VIF (variance inflation factor), which tests collinearity.\n
     """
 
     _location_path = "econometrics"

openbb_terminal/core/sdk/models/stocks_sdk_model.py

@@ -446,18 +446,15 @@ def __init__(self):
 class StocksOptions(Category):
     """Options Module.
 
-        Submodules:
-        `screen`: Screen Module
-
     Attributes:
         `chains`: Get Option Chain For A Stock.  No greek data is returned\n
         `dte`: Returns a new column containing the DTE as an integer, including 0.\n
         `eodchain`: Get full EOD option date across all expirations\n
         `expirations`: Get Option Chain Expirations\n
         `generate_data`: Gets x values, and y values before and after premiums\n
         `greeks`: Gets the greeks for a given option\n
-        `grhist`: Get histoical option greeks\n
-        `grhist_chart`: Plots historical greeks for a given option. [Source: Syncretism]\n
+        `grhist`: Get historical EOD option prices, with Greeks, for a given OCC chain label.\n
+        `grhist_chart`: Plots historical greeks for a given option.\n
         `hist`: Get historical option pricing.\n
         `info`: Scrape barchart for options info\n
         `info_chart`: Scrapes Barchart.com for the options information\n
@@ -484,10 +481,8 @@ def __init__(self):
         self.expirations = lib.stocks_options_sdk_helper.get_option_expirations
         self.generate_data = lib.stocks_options_yfinance_model.generate_data
         self.greeks = lib.stocks_options_sdk_helper.get_greeks
-        self.grhist = lib.stocks_options_screen_syncretism_model.get_historical_greeks
-        self.grhist_chart = (
-            lib.stocks_options_screen_syncretism_view.view_historical_greeks
-        )
+        self.grhist = lib.stocks_options_intrinio_model.get_historical_options
+        self.grhist_chart = lib.stocks_options_intrinio_view.view_historical_greeks
         self.hist = lib.stocks_options_sdk_helper.hist
         self.info = lib.stocks_options_barchart_model.get_options_info
         self.info_chart = lib.stocks_options_barchart_view.print_options_data

openbb_terminal/core/sdk/sdk_init.py

@@ -481,11 +481,6 @@
     yfinance_view as stocks_options_yfinance_view,
 )
 
-from openbb_terminal.stocks.options.screen import (
-    syncretism_model as stocks_options_screen_syncretism_model,
-    syncretism_view as stocks_options_screen_syncretism_view,
-)
-
 
 # Stocks - Screener
 

openbb_terminal/core/sdk/trail_map.csv

@@ -173,6 +173,7 @@ econometrics.comparison,econometrics_regression_model.get_comparison,
 econometrics.dwat,econometrics_regression_model.get_dwat,econometrics_regression_view.display_dwat
 econometrics.fdols,econometrics_regression_model.get_fdols,
 econometrics.fe,econometrics_regression_model.get_fe,
+econometrics.garch,econometrics_model.get_garch,econometrics_view.display_garch
 econometrics.get_regression_data,econometrics_regression_model.get_regression_data,
 econometrics.granger,econometrics_model.get_granger_causality,econometrics_view.display_granger
 econometrics.load,common_model.load,
@@ -184,7 +185,6 @@ econometrics.pols,econometrics_regression_model.get_pols,
 econometrics.re,econometrics_regression_model.get_re,
 econometrics.root,econometrics_model.get_root,econometrics_view.display_root
 econometrics.vif,econometrics_model.get_vif,
-econometrics.garch,econometrics_model.get_garch,econometrics_view.display_garch
 economy.available_indices,economy_yfinance_model.get_available_indices,
 economy.balance,economy_oecd_model.get_balance,economy_oecd_view.plot_balance
 economy.bigmac,economy_nasdaq_model.get_big_mac_indices,economy_nasdaq_view.display_big_mac_index
@@ -286,6 +286,7 @@ futures.search,futures_yfinance_model.get_search_futures,
 keys.av,keys_model.set_av_key,
 keys.binance,keys_model.set_binance_key,
 keys.bitquery,keys_model.set_bitquery_key,
+keys.biztoc,keys_model.set_biztoc_key,
 keys.cmc,keys_model.set_cmc_key,
 keys.coinbase,keys_model.set_coinbase_key,
 keys.coinglass,keys_model.set_coinglass_key,
@@ -303,7 +304,6 @@ keys.glassnode,keys_model.set_glassnode_key,
 keys.messari,keys_model.set_messari_key,
 keys.mykeys,keys_model.get_keys,
 keys.news,keys_model.set_news_key,
-keys.biztoc,keys_model.set_biztoc_key,
 keys.oanda,keys_model.set_oanda_key,
 keys.polygon,keys_model.set_polygon_key,
 keys.quandl,keys_model.set_quandl_key,
@@ -515,15 +515,13 @@ stocks.options.eodchain,stocks_options_intrinio_model.get_full_chain_eod,
 stocks.options.expirations,stocks_options_sdk_helper.get_option_expirations,
 stocks.options.generate_data,stocks_options_yfinance_model.generate_data,
 stocks.options.greeks,stocks_options_sdk_helper.get_greeks,
-stocks.options.grhist,stocks_options_screen_syncretism_model.get_historical_greeks,stocks_options_screen_syncretism_view.view_historical_greeks
+stocks.options.grhist,stocks_options_intrinio_model.get_historical_options,stocks_options_intrinio_view.view_historical_greeks
 stocks.options.hist,stocks_options_sdk_helper.hist,
 stocks.options.info,stocks_options_barchart_model.get_options_info,stocks_options_barchart_view.print_options_data
 stocks.options.last_price,stocks_options_tradier_model.get_last_price,
 stocks.options.oi,stocks_options_view.plot_oi,
 stocks.options.pcr,stocks_options_alphaquery_model.get_put_call_ratio,stocks_options_alphaquery_view.display_put_call_ratio
 stocks.options.price,stocks_options_sdk_helper.get_option_current_price,
-stocks.options.screen.check_presets,stocks_options_screen_syncretism_model.check_presets,
-stocks.options.screen.screener_output,stocks_options_screen_syncretism_model.get_screener_output,stocks_options_screen_syncretism_view.view_screener_output
 stocks.options.unu,stocks_options_fdscanner_model.unusual_options,stocks_options_fdscanner_view.display_options
 stocks.options.voi,stocks_options_view.plot_voi,
 stocks.options.vol,stocks_options_view.plot_vol,

openbb_terminal/miscellaneous/i18n/en.yml

@@ -146,7 +146,6 @@ en:
   stocks/forecast: forecast techniques           rnn, nbeats, transformer, block rnn
   stocks/options/unu: show unusual options activity
   stocks/options/calc: basic call/put PnL calculator
-  stocks/options/screen: screens tickers based on preset
   stocks/options/load: load new ticker
   stocks/options/exp: see and set expiration dates
   stocks/options/_ticker: Ticker
@@ -165,12 +164,6 @@ en:
   stocks/options/eodchain: gets option chain at a specific date
   stocks/options/pricing: shows options pricing and risk neutral valuation
   stocks/options/hedge: shows portfolio weights in order to neutralise delta
-  stocks/options/screen/view: view available presets (or one in particular)
-  stocks/options/screen/set: set one of the available presets
-  stocks/options/screen/_preset: Preset
-  stocks/options/screen/scr: screen data from this preset
-  stocks/options/screen/_screened_tickers: Last screened tickers
-  stocks/options/screen/ca: take these to comparison analysis menu
   stocks/options/hedge/_ticker: Ticker
   stocks/options/hedge/_expiry: Expiry
   stocks/options/hedge/pick: pick the underlying asset position

openbb_terminal/miscellaneous/integration_tests_scripts/stocks/test_options.openbb

@@ -1,11 +1,5 @@
 stocks
 options
-screen
-view
-view --preset high_IV.ini
-set --preset high_IV.ini
-scr
-q
 unu -l 2 -s Strike -r -c
 unu -l 2 -s Vol
 calc

openbb_terminal/miscellaneous/sources/openbb_default.json

@@ -51,15 +51,6 @@
         "FDScanner"
       ],
       "calc": [],
-      "screen": {
-        "view": [
-          "Syncretism"
-        ],
-        "set": [],
-        "scr": [
-          "Syncretism"
-        ]
-      },
       "load": [
         "YahooFinance",
         "Tradier",
@@ -81,7 +72,6 @@
         "YahooFinance"
       ],
       "grhist": [
-        "Syncretism",
         "Intrinio"
       ],
       "plot": [