summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Maslek <jmaslek11@gmail.com>2023-03-07 20:04:22 -0500
committerJames Maslek <jmaslek11@gmail.com>2023-03-07 20:04:22 -0500
commit20ca67c19b59e748df0dc962eeb79fc443caabc7 (patch)
tree691af664e916e77e64abdc2927bbb8b96a63046e
parentfcd22a6d3f3eba5379448e52882521d2c7de54c2 (diff)
Edit some structure
-rw-r--r--openbb_terminal/alternative/covid/covid_model.py15
-rw-r--r--openbb_terminal/alternative/covid/covid_view.py11
-rw-r--r--openbb_terminal/core/sdk/models/economy_sdk_model.py2
-rw-r--r--openbb_terminal/core/sdk/trail_map.csv1
-rw-r--r--openbb_terminal/economy/fred_model.py53
-rw-r--r--openbb_terminal/economy/fred_view.py3
-rw-r--r--openbb_terminal/economy/yfinance_model.py6
-rw-r--r--openbb_terminal/economy/yfinance_view.py5
-rw-r--r--openbb_terminal/sdk.py19
-rw-r--r--openbb_terminal/stocks/discovery/seeking_alpha_view.py3
-rw-r--r--openbb_terminal/stocks/fundamental_analysis/csimarket_model.py13
-rw-r--r--openbb_terminal/stocks/fundamental_analysis/csimarket_view.py5
12 files changed, 32 insertions, 104 deletions
diff --git a/openbb_terminal/alternative/covid/covid_model.py b/openbb_terminal/alternative/covid/covid_model.py
index 4995ce4f93c..51da491487f 100644
--- a/openbb_terminal/alternative/covid/covid_model.py
+++ b/openbb_terminal/alternative/covid/covid_model.py
@@ -89,7 +89,6 @@ def get_global_deaths(country: str) -> pd.DataFrame:
@log_start_end(log=logger)
def get_covid_ov(
country: str,
- limit: int = 100,
) -> pd.DataFrame:
"""Get historical cases and deaths by country.
@@ -97,8 +96,6 @@ def get_covid_ov(
----------
country: str
Country to get data for
- limit: int
- Number of raw data to show
Returns
-------
@@ -114,14 +111,13 @@ def get_covid_ov(
data = pd.concat([cases, deaths], axis=1)
data.columns = ["Cases", "Deaths"]
data.index = [x.strftime("%Y-%m-%d") for x in data.index]
- return data.tail(limit)
+ return data
@log_start_end(log=logger)
def get_covid_stat(
country: str,
stat: str = "cases",
- limit: int = 10,
) -> pd.DataFrame:
"""Show historical cases and deaths by country.
@@ -131,8 +127,6 @@ def get_covid_stat(
Country to get data for
stat: str
Statistic to get. Either "cases", "deaths" or "rates"
- limit: int
- Number of raw data to show
Returns
-------
@@ -151,13 +145,12 @@ def get_covid_stat(
console.print("Invalid stat selected.\n")
return pd.DataFrame()
data.index = [x.strftime("%Y-%m-%d") for x in data.index]
- return data.tail(limit)
+ return data
@log_start_end(log=logger)
def get_case_slopes(
days_back: int = 30,
- limit: int = 50,
threshold: int = 10000,
ascend: bool = False,
) -> pd.DataFrame:
@@ -167,8 +160,6 @@ def get_case_slopes(
----------
days_back: int
Number of historical days to consider
- limit: int
- Number of rows to show
threshold: int
Threshold for total number of cases
ascend: bool
@@ -204,4 +195,4 @@ def get_case_slopes(
hist_slope.sort_values(by="Slope", ascending=ascend, inplace=True)
else:
hist_slope.sort_values(by="Slope", ascending=ascend, inplace=True)
- return hist_slope.head(limit)
+ return hist_slope
diff --git a/openbb_terminal/alternative/covid/covid_view.py b/openbb_terminal/alternative/covid/covid_view.py
index 93940307fea..789df23cc21 100644
--- a/openbb_terminal/alternative/covid/covid_view.py
+++ b/openbb_terminal/alternative/covid/covid_view.py
@@ -186,7 +186,7 @@ def display_covid_ov(
if plot or fig.is_image_export(export):
fig = plot_covid_ov(country, external_axes=True)
if raw:
- data = covid_model.get_covid_ov(country, limit)
+ data = covid_model.get_covid_ov(country)
print_rich_table(
data,
headers=[x.title() for x in data.columns],
@@ -194,10 +194,11 @@ def display_covid_ov(
index_name="Date",
title=f"[bold]{country} COVID Numbers[/bold]",
export=bool(export),
+ limit=limit,
)
if export:
- data = covid_model.get_covid_ov(country, limit)
+ data = covid_model.get_covid_ov(country)
export_data(
export,
os.path.dirname(os.path.abspath(__file__)),
@@ -240,7 +241,7 @@ def display_covid_stat(
Flag to plot data
"""
fig = OpenBBFigure()
- data = covid_model.get_covid_stat(country, stat, limit)
+ data = covid_model.get_covid_stat(country, stat)
if plot or fig.is_image_export(export):
fig = plot_covid_stat(country, stat, external_axes=True) # type: ignore
@@ -253,6 +254,7 @@ def display_covid_stat(
index_name="Date",
title=f"[bold]{country} COVID {stat}[/bold]",
export=bool(export),
+ limit=limit,
)
if export:
data["date"] = data.index
@@ -297,7 +299,7 @@ def display_case_slopes(
export : str
Format to export data
"""
- data = covid_model.get_case_slopes(days_back, limit, threshold, ascend)
+ data = covid_model.get_case_slopes(days_back, threshold, ascend)
print_rich_table(
data,
@@ -305,6 +307,7 @@ def display_case_slopes(
index_name="Country",
title=f"[bold]{('Highest','Lowest')[ascend]} Sloping Cases[/bold] (Cases/Day)",
export=bool(export),
+ limit=limit,
)
export_data(
diff --git a/openbb_terminal/core/sdk/models/economy_sdk_model.py b/openbb_terminal/core/sdk/models/economy_sdk_model.py
index 979d466302a..afff3886a38 100644
--- a/openbb_terminal/core/sdk/models/economy_sdk_model.py
+++ b/openbb_terminal/core/sdk/models/economy_sdk_model.py
@@ -19,7 +19,6 @@ class EconomyRoot(Category):
`events`: Get economic calendar for countries between specified dates\n
`fred`: Get Series data. [Source: FRED]\n
`fred_chart`: Display (multiple) series from https://fred.stlouisfed.org. [Source: FRED]\n
- `fred_ids`: Get Series IDs. [Source: FRED]\n
`fred_notes`: Get series notes. [Source: FRED]\n
`future`: Get futures data. [Source: Finviz]\n
`futures`: Get futures data.\n
@@ -60,7 +59,6 @@ class EconomyRoot(Category):
self.events = lib.economy_nasdaq_model.get_economic_calendar
self.fred = lib.economy_fred_model.get_aggregated_series_data
self.fred_chart = lib.economy_fred_view.display_fred_series
- self.fred_ids = lib.economy_fred_model.get_series_ids
self.fred_notes = lib.economy_fred_model.get_series_notes
self.future = lib.economy_finviz_model.get_futures
self.futures = lib.economy_sdk_helpers.futures
diff --git a/openbb_terminal/core/sdk/trail_map.csv b/openbb_terminal/core/sdk/trail_map.csv
index 9ba71425e0a..b59917d8473 100644
--- a/openbb_terminal/core/sdk/trail_map.csv
+++ b/openbb_terminal/core/sdk/trail_map.csv
@@ -184,7 +184,6 @@ economy.country_codes,economy_nasdaq_model.get_country_codes,
economy.currencies,economy_wsj_model.global_currencies,
economy.events,economy_nasdaq_model.get_economic_calendar,
economy.fred,economy_fred_model.get_aggregated_series_data,economy_fred_view.display_fred_series
-economy.fred_ids,economy_fred_model.get_series_ids,
economy.fred_notes,economy_fred_model.get_series_notes,
economy.future,economy_finviz_model.get_futures,
economy.futures,economy_sdk_helpers.futures,
diff --git a/openbb_terminal/economy/fred_model.py b/openbb_terminal/economy/fred_model.py
index 5e025684b87..778064aea7d 100644
--- a/openbb_terminal/economy/fred_model.py
+++ b/openbb_terminal/economy/fred_model.py
@@ -127,15 +127,15 @@ def check_series_id(series_id: str) -> Tuple[bool, dict]:
@log_start_end(log=logger)
@check_api_key(["API_FRED_KEY"])
-def get_series_notes(search_query: str, limit: int = -1) -> pd.DataFrame:
+def get_series_notes(
+ search_query: str,
+) -> pd.DataFrame:
"""Get series notes. [Source: FRED]
Parameters
----------
search_query : str
Text query to search on fred series notes database
- limit : int
- Maximum number of series notes to display
Returns
-------
@@ -176,58 +176,11 @@ def get_series_notes(search_query: str, limit: int = -1) -> pd.DataFrame:
else x
)
- if limit != -1:
- df_fred = df_fred[:limit]
-
return df_fred
@log_start_end(log=logger)
@check_api_key(["API_FRED_KEY"])
-def get_series_ids(search_query: str, limit: int = -1) -> pd.DataFrame:
- """Get Series IDs. [Source: FRED]
-
- Parameters
- ----------
- search_query : str
- Text query to search on fred series notes database
- limit : int
- Maximum number of series IDs to output
-
- Returns
- -------
- pd.Dataframe
- Dataframe with series IDs and titles
- """
- fred.key(get_current_user().credentials.API_FRED_KEY)
- d_series = fred.search(search_query)
-
- # Cover invalid api and empty search terms
- if "error_message" in d_series:
- if "api_key" in d_series["error_message"]:
- console.print("[red]Invalid API Key[/red]\n")
- else:
- console.print(d_series["error_message"])
- return pd.DataFrame()
-
- if "seriess" not in d_series:
- return pd.DataFrame()
-
- if not d_series["seriess"]:
- return pd.DataFrame()
-
- df_series = pd.DataFrame(d_series["seriess"])
- df_series = df_series.sort_values(by=["popularity"], ascending=False)
- if limit != -1:
- df_series = df_series.head(limit)
- df_series = df_series[["id", "title"]]
- df_series.set_index("id", inplace=True)
-
- return df_series
-
-
-@log_start_end(log=logger)
-@check_api_key(["API_FRED_KEY"])
def get_series_data(
series_id: str, start_date: Optional[str] = None, end_date: Optional[str] = None
) -> pd.DataFrame:
diff --git a/openbb_terminal/economy/fred_view.py b/openbb_terminal/economy/fred_view.py
index e5cdfa2b688..14ed1c6669d 100644
--- a/openbb_terminal/economy/fred_view.py
+++ b/openbb_terminal/economy/fred_view.py
@@ -50,7 +50,7 @@ def notes(search_query: str, limit: int = 10):
limit : int
Maximum number of series notes to display
"""
- df_search = fred_model.get_series_notes(search_query, limit)
+ df_search = fred_model.get_series_notes(search_query)
if df_search.empty:
return
@@ -60,6 +60,7 @@ def notes(search_query: str, limit: int = 10):
title=f"[bold]Search results for {search_query}[/bold]",
show_index=False,
headers=["Series ID", "Title", "Description"],
+ limit=limit,
)
diff --git a/openbb_terminal/economy/yfinance_model.py b/openbb_terminal/economy/yfinance_model.py
index e124e35841a..b4bcdaf0617 100644
--- a/openbb_terminal/economy/yfinance_model.py
+++ b/openbb_terminal/economy/yfinance_model.py
@@ -719,15 +719,13 @@ def get_indices(
@log_start_end(log=logger)
-def get_search_indices(keyword: list, limit: int = 10) -> pd.DataFrame:
+def get_search_indices(keyword: list) -> pd.DataFrame:
"""Search indices by keyword. [Source: FinanceDatabase]
Parameters
----------
keyword: list
The keyword you wish to search for. This can include spaces.
- limit: int
- The amount of views you want to show, by default this is set to 10.
Returns
-------
@@ -749,6 +747,4 @@ def get_search_indices(keyword: list, limit: int = 10) -> pd.DataFrame:
)
queried_indices = queried_indices.drop_duplicates()
- queried_indices = queried_indices.iloc[:limit]
-
return keyword_adjusted, queried_indices
diff --git a/openbb_terminal/economy/yfinance_view.py b/openbb_terminal/economy/yfinance_view.py
index 5c4c6835560..da01f6edf9d 100644
--- a/openbb_terminal/economy/yfinance_view.py
+++ b/openbb_terminal/economy/yfinance_view.py
@@ -136,12 +136,13 @@ def search_indices(query: list, limit: int = 10):
Shows a rich table with the available options.
"""
- keyword_adjusted, queried_indices = get_search_indices(query, limit)
+ keyword_adjusted, queried_indices = get_search_indices(query)
print_rich_table(
queried_indices,
show_index=True,
index_name="ticker",
- headers=queried_indices.columns,
+ headers=list(queried_indices.columns),
title=f"Queried Indices with keyword {keyword_adjusted}",
+ limit=limit,
)
diff --git a/openbb_terminal/sdk.py b/openbb_terminal/sdk.py
index a40c437c4cd..a1df14b3b34 100644
--- a/openbb_terminal/sdk.py
+++ b/openbb_terminal/sdk.py
@@ -2,13 +2,13 @@
# ######### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ######### #
# flake8: noqa
# pylint: disable=unused-import,wrong-import-order
+# pylint: disable=C0302,W0611,R0902,R0903,C0412,C0301,not-callable
import logging
import openbb_terminal.config_terminal as cfg
from openbb_terminal import helper_funcs as helper # noqa: F401
from openbb_terminal.base_helpers import load_env_files
from openbb_terminal.config_terminal import theme
-from openbb_terminal.core.config.paths_helper import init_userdata
from openbb_terminal.cryptocurrency.due_diligence.pycoingecko_model import Coin
from openbb_terminal.dashboards.dashboards_controller import DashboardsController
@@ -41,7 +41,7 @@ class OpenBBSDK:
`whoami`: Display user info.\n
"""
- __version__ = cfg.VERSION
+ __version__ = obbff.VERSION
def __init__(self):
SDKLogger()
@@ -49,14 +49,7 @@ class OpenBBSDK:
self.logout = lib.sdk_session.logout
self.news = lib.common_feedparser_model.get_news
self.whoami = lib.sdk_session.whoami
- self._try_to_login()
-
- def _try_to_login(self):
- if is_local() and is_auth_enabled():
- try:
- self.login()
- except Exception:
- pass
+ SDKLogger._try_to_login(self)
@property
def alt(self):
@@ -149,7 +142,6 @@ class OpenBBSDK:
`events`: Get economic calendar for countries between specified dates\n
`fred`: Get Series data. [Source: FRED]\n
`fred_chart`: Display (multiple) series from https://fred.stlouisfed.org. [Source: FRED]\n
- `fred_ids`: Get Series IDs. [Source: FRED]\n
`fred_notes`: Get series notes. [Source: FRED]\n
`future`: Get futures data. [Source: Finviz]\n
`futures`: Get futures data.\n
@@ -541,7 +533,7 @@ class OpenBBSDK:
`obv_chart`: Plots OBV technical indicator\n
`rsi`: Relative strength index\n
`rsi_chart`: Plots RSI Indicator\n
- `rvol_garman_klass`: Garman-Klass volatility extends Parkinson volatility by taking into account the open and close price.\n
+ `rvol_garman_klass`: Garman-Klass volatility extends Parkinson volatility by taking into account the opening and closing price.\n
`rvol_hodges_tompkins`: Hodges-Tompkins volatility is a bias correction for estimation using an overlapping data sample.\n
`rvol_parkinson`: Parkinson volatility uses the high and low price of the day rather than just close to close prices.\n
`rvol_rogers_satchell`: Rogers-Satchell is an estimator for measuring the volatility with an average return not equal to zero.\n
@@ -560,7 +552,6 @@ class OpenBBSDK:
return model.TaRoot()
-# pylint: disable=too-few-public-methods
class SDKLogger:
def __init__(self) -> None:
self.__check_initialize_logging()
@@ -581,7 +572,7 @@ class SDKLogger:
@staticmethod
def _try_to_login(sdk: "OpenBBSDK"):
- if is_local() and is_auth_enabled():
+ if User.is_guest() and is_auth_enabled():
try:
sdk.login()
except Exception:
diff --git a/openbb_terminal/stocks/discovery/seeking_alpha_view.py b/openbb_terminal/stocks/discovery/seeking_alpha_view.py
index 2dab7415d0b..6b7c6043606 100644
--- a/openbb_terminal/stocks/discovery/seeking_alpha_view.py
+++ b/openbb_terminal/stocks/discovery/seeking_alpha_view.py
@@ -27,7 +27,7 @@ def upcoming_earning_release_dates(
Parameters
----------
num_pages: int
- Number of pages to scrap
+ Number of pages to scrape
limit: int
Number of upcoming earnings release dates
export : str
@@ -42,7 +42,6 @@ def upcoming_earning_release_dates(
if df_earnings.empty:
console.print("No upcoming earnings release dates found")
- pd.set_option("display.max_colwidth", None)
if export:
l_earnings = []
l_earnings_dates = []
diff --git a/openbb_terminal/stocks/fundamental_analysis/csimarket_model.py b/openbb_terminal/stocks/fundamental_analysis/csimarket_model.py
index 0131f3fa485..d78160ff403 100644
--- a/openbb_terminal/stocks/fundamental_analysis/csimarket_model.py
+++ b/openbb_terminal/stocks/fundamental_analysis/csimarket_model.py
@@ -39,15 +39,13 @@ def clean_table(df: pd.DataFrame) -> pd.DataFrame:
@log_start_end(log=logger)
-def get_suppliers(symbol: str, limit: int = 50) -> pd.DataFrame:
+def get_suppliers(symbol: str) -> pd.DataFrame:
"""Get suppliers from ticker provided. [Source: CSIMarket]
Parameters
----------
symbol: str
Ticker to select suppliers from
- limit: int
- The maximum number of rows to show
Returns
-------
@@ -58,20 +56,17 @@ def get_suppliers(symbol: str, limit: int = 50) -> pd.DataFrame:
dfs = pd.read_html(url, header=0)
df = dfs[10]
df = clean_table(df)
-
- return df.head(limit)
+ return df
@log_start_end(log=logger)
-def get_customers(symbol: str, limit: int = 50) -> pd.DataFrame:
+def get_customers(symbol: str) -> pd.DataFrame:
"""Print customers from ticker provided
Parameters
----------
symbol: str
Ticker to select customers from
- limit: int
- The maximum number of rows to show
Returns
-------
@@ -83,4 +78,4 @@ def get_customers(symbol: str, limit: int = 50) -> pd.DataFrame:
df = dfs[9]
df = clean_table(df)
- return df.head(limit)
+ return df
diff --git a/openbb_terminal/stocks/fundamental_analysis/csimarket_view.py b/openbb_terminal/stocks/fundamental_analysis/csimarket_view.py
index 71812b3f768..91f4c6cd44c 100644
--- a/openbb_terminal/stocks/fundamental_analysis/csimarket_view.py
+++ b/openbb_terminal/stocks/fundamental_analysis/csimarket_view.py
@@ -30,17 +30,18 @@ def suppliers(
limit: int
The maximum number of rows to show
"""
- tickers = csimarket_model.get_suppliers(symbol, limit=limit)
+ tickers = csimarket_model.get_suppliers(symbol)
+
if tickers.empty:
console.print("No suppliers found.\n")
else:
- console.print(f"List of suppliers: {', '.join(tickers)}\n")
print_rich_table(
tickers,
headers=list(tickers.columns),
show_index=True,
title=f"Suppliers for {symbol.upper()}",
export=bool(export),
+ limit=limit,
)
export_data(