From c29d1c5c206cefeec54bebb0cf558ab7ccaaa319 Mon Sep 17 00:00:00 2001 From: James Simmons <53658028+simmonsj330@users.noreply.github.com> Date: Sat, 22 Oct 2022 23:57:15 -0400 Subject: [PATCH] Changing reddit_sent command name (part 2) (#2986) * hoping this works * Moving files and adding test Co-authored-by: James Maslek --- .../common/behavioural_analysis/reddit_view.py | 2 +- .../miscellaneous/data_sources_default.json | 2 +- openbb_terminal/miscellaneous/i18n/en.yml | 2 +- .../miscellaneous/scripts/test_stocks_ba.openbb | 2 +- openbb_terminal/sdk.py | 4 ++-- .../stocks/behavioural_analysis/ba_controller.py | 14 +++++++------- .../txt/test_ba_controller/test_print_help.txt | 2 +- .../ba/{reddit_sent => redditsent}/_index.md | 8 ++++---- .../ba/{reddit_sent => redditsent}/_index.md | 4 ++-- website/data/menu/main.yml | 12 ++++++------ 10 files changed, 26 insertions(+), 26 deletions(-) rename website/content/SDK/stocks/ba/{reddit_sent => redditsent}/_index.md (73%) rename website/content/terminal/common/ba/{reddit_sent => redditsent}/_index.md (91%) diff --git a/openbb_terminal/common/behavioural_analysis/reddit_view.py b/openbb_terminal/common/behavioural_analysis/reddit_view.py index bacfa04d18b..61a48ab7487 100644 --- a/openbb_terminal/common/behavioural_analysis/reddit_view.py +++ b/openbb_terminal/common/behavioural_analysis/reddit_view.py @@ -394,7 +394,7 @@ def display_due_diligence( "API_REDDIT_PASSWORD", ] ) -def display_reddit_sent( +def display_redditsent( symbol: str, sortby: str = "relevance", limit: int = 100, diff --git a/openbb_terminal/miscellaneous/data_sources_default.json b/openbb_terminal/miscellaneous/data_sources_default.json index bed88c69dc4..635ed17c795 100644 --- a/openbb_terminal/miscellaneous/data_sources_default.json +++ b/openbb_terminal/miscellaneous/data_sources_default.json @@ -168,7 +168,7 @@ "spacc": ["Reddit"], "spac": ["Reddit"], "getdd": ["Reddit"], - "reddit_sent": ["Reddit"], + "redditsent": ["Reddit"], "trending": ["Stocktwits"], "stalker": ["Stocktwits"], "bullbear": ["Stocktwits"], diff --git a/openbb_terminal/miscellaneous/i18n/en.yml b/openbb_terminal/miscellaneous/i18n/en.yml index b06b9c3a3c7..82c595ad808 100644 --- a/openbb_terminal/miscellaneous/i18n/en.yml +++ b/openbb_terminal/miscellaneous/i18n/en.yml @@ -313,7 +313,7 @@ en: stocks/ba/spacc: show other users spacs announcements from subreddit SPACs stocks/ba/spac: show other users spacs announcements from other subs stocks/ba/getdd: gets due diligence from another user's post - stocks/ba/reddit_sent: searches reddit for ticker and finds reddit sentiment + stocks/ba/redditsent: searches reddit for ticker and finds reddit sentiment stocks/ba/trending: trending stocks stocks/ba/stalker: stalk stocktwits user's last messages stocks/ba/bullbear: estimate quick sentiment from last 30 messages on board diff --git a/openbb_terminal/miscellaneous/scripts/test_stocks_ba.openbb b/openbb_terminal/miscellaneous/scripts/test_stocks_ba.openbb index 532f5024156..7e83e2afc2a 100644 --- a/openbb_terminal/miscellaneous/scripts/test_stocks_ba.openbb +++ b/openbb_terminal/miscellaneous/scripts/test_stocks_ba.openbb @@ -10,7 +10,7 @@ popular -l 5 -n 10 spacc spac getdd -reddit_sent +redditsent trending stalker -l 3 bullbear diff --git a/openbb_terminal/sdk.py b/openbb_terminal/sdk.py index 374582a08e6..52ba5b6b503 100644 --- a/openbb_terminal/sdk.py +++ b/openbb_terminal/sdk.py @@ -123,9 +123,9 @@ functions = { "model": "openbb_terminal.common.behavioural_analysis.reddit_model.get_popular_tickers", "view": "openbb_terminal.common.behavioural_analysis.reddit_view.display_popular_tickers", }, - "stocks.ba.reddit_sent": { + "stocks.ba.redditsent": { "model": "openbb_terminal.common.behavioural_analysis.reddit_model.get_posts_about", - "view": "openbb_terminal.common.behavioural_analysis.reddit_view.display_reddit_sent", + "view": "openbb_terminal.common.behavioural_analysis.reddit_view.display_redditsent", }, "stocks.ba.text_sent": { "model": "openbb_terminal.common.behavioural_analysis.reddit_model.get_sentiment" diff --git a/openbb_terminal/stocks/behavioural_analysis/ba_controller.py b/openbb_terminal/stocks/behavioural_analysis/ba_controller.py index 6ccefe7a625..99cc2b2624f 100644 --- a/openbb_terminal/stocks/behavioural_analysis/ba_controller.py +++ b/openbb_terminal/stocks/behavioural_analysis/ba_controller.py @@ -53,7 +53,7 @@ class BehaviouralAnalysisController(StockBaseController): "stalker", "infer", "sentiment", - "reddit_sent", + "redditsent", "mentions", "regions", "queries", @@ -142,7 +142,7 @@ class BehaviouralAnalysisController(StockBaseController): "--all": {}, "-a": "--all", } - choices["reddit_sent"] = { + choices["redditsent"] = { "--sort": {c: {} for c in self.reddit_sort}, "-s": "--sort", "--company": None, @@ -210,7 +210,7 @@ class BehaviouralAnalysisController(StockBaseController): mt.add_cmd("spacc") mt.add_cmd("spac") mt.add_cmd("getdd", self.ticker) - mt.add_cmd("reddit_sent", self.ticker) + mt.add_cmd("redditsent", self.ticker) mt.add_cmd("trending") mt.add_cmd("stalker") mt.add_cmd("bullbear", self.ticker) @@ -466,11 +466,11 @@ class BehaviouralAnalysisController(StockBaseController): console.print("No ticker loaded. Please load using 'load '\n") @log_start_end(log=logger) - def call_reddit_sent(self, other_args: List[str]): - """Process reddit_sent command""" + def call_redditsent(self, other_args: List[str]): + """Process redditsent command""" parser = argparse.ArgumentParser( add_help=False, - prog="reddit_sent", + prog="redditsent", description=""" Determine general Reddit sentiment about a ticker. [Source: Reddit] """, @@ -548,7 +548,7 @@ class BehaviouralAnalysisController(StockBaseController): if ns_parser: ticker = ns_parser.company if ns_parser.company else self.ticker if self.ticker: - reddit_view.display_reddit_sent( + reddit_view.display_redditsent( symbol=ticker, sortby=ns_parser.sort, limit=ns_parser.limit, diff --git a/tests/openbb_terminal/stocks/behavioural_analysis/txt/test_ba_controller/test_print_help.txt b/tests/openbb_terminal/stocks/behavioural_analysis/txt/test_ba_controller/test_print_help.txt index 8759ae4b7aa..2d68480f193 100644 --- a/tests/openbb_terminal/stocks/behavioural_analysis/txt/test_ba_controller/test_print_help.txt +++ b/tests/openbb_terminal/stocks/behavioural_analysis/txt/test_ba_controller/test_print_help.txt @@ -10,7 +10,7 @@ Ticker: TSLA spacc show other users spacs announcements from subreddit SPACs [Reddit] spac show other users spacs announcements from other subs [Reddit] getdd gets due diligence from another user's post [Reddit] - reddit_sent searches reddit for ticker and finds reddit sentiment [Reddit] + redditsent searches reddit for ticker and finds reddit sentiment [Reddit] trending trending stocks [Stocktwits] stalker stalk stocktwits user's last messages [Stocktwits] bullbear estimate quick sentiment from last 30 messages on board [Stocktwits] diff --git a/website/content/SDK/stocks/ba/reddit_sent/_index.md b/website/content/SDK/stocks/ba/redditsent/_index.md similarity index 73% rename from website/content/SDK/stocks/ba/reddit_sent/_index.md rename to website/content/SDK/stocks/ba/redditsent/_index.md index f93c565d3a1..88d0bf87447 100644 --- a/website/content/SDK/stocks/ba/reddit_sent/_index.md +++ b/website/content/SDK/stocks/ba/redditsent/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter -## Get underlying data -### stocks.ba.reddit_sent(symbol: str, limit: int = 100, sortby: str = 'relevance', time_frame: str = 'week', full_search: bool = True, subreddits: str = 'all') -> Tuple[pandas.core.frame.DataFrame, list, float] +## Get underlying data +### stocks.ba.redditsent(symbol: str, limit: int = 100, sortby: str = 'relevance', time_frame: str = 'week', full_search: bool = True, subreddits: str = 'all') -> Tuple[pandas.core.frame.DataFrame, list, float] Finds posts related to a specific search term in Reddit @@ -29,8 +29,8 @@ Finds posts related to a specific search term in Reddit List of polarity scores, Average polarity score -## Getting charts -### stocks.ba.reddit_sent(symbol: str, sortby: str = 'relevance', limit: int = 100, graphic: bool = False, time_frame: str = 'week', full_search: bool = True, subreddits: str = 'all', display: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +## Getting charts +### stocks.ba.redditsent(symbol: str, sortby: str = 'relevance', limit: int = 100, graphic: bool = False, time_frame: str = 'week', full_search: bool = True, subreddits: str = 'all', display: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Determine Reddit sentiment about a search term Parameters diff --git a/website/content/terminal/common/ba/reddit_sent/_index.md b/website/content/terminal/common/ba/redditsent/_index.md similarity index 91% rename from website/content/terminal/common/ba/reddit_sent/_index.md rename to website/content/terminal/common/ba/redditsent/_index.md index e4fe826b7d2..7fc30be5545 100644 --- a/website/content/terminal/common/ba/reddit_sent/_index.md +++ b/website/content/terminal/common/ba/redditsent/_index.md @@ -1,5 +1,5 @@ ```txt -usage: reddit_sent [-s {relevance,hot,top,new,comments}] [-c COMPANY] [--subreddits SUBREDDITS] [-l LIMIT] +usage: redditsent [-s {relevance,hot,top,new,comments}] [-c COMPANY] [--subreddits SUBREDDITS] [-l LIMIT] [-t {hour,day,week,month,year,all}] [-f] [-g] [-h] [--export EXPORT] ``` @@ -27,7 +27,7 @@ optional arguments: Example: ```txt -reddit_sent -c Google --subreddits tech,stocks --full +redditsent -c Google --subreddits tech,stocks --full Searching through subreddits for posts. 100%|█████████████████████████████████████████████████████████████████████████| 2/2 [00:01<00:00, 1.84it/s] Analyzing each post... diff --git a/website/data/menu/main.yml b/website/data/menu/main.yml index daaae000aa6..cfa7a7e77c5 100644 --- a/website/data/menu/main.yml +++ b/website/data/menu/main.yml @@ -60,8 +60,8 @@ main: ref: /terminal/common/ba/popular - name: queries ref: /terminal/common/ba/queries - - name: reddit_sent - ref: /terminal/common/ba/reddit_sent + - name: redditsent + ref: /terminal/common/ba/redditsent - name: regions ref: /terminal/common/ba/regions - name: rise @@ -1111,8 +1111,8 @@ main: ref: /terminal/common/ba/popular - name: queries ref: /terminal/common/ba/queries - - name: reddit_sent - ref: /terminal/common/ba/reddit_sent + - name: redditsent + ref: /terminal/common/ba/redditsent - name: regions ref: /terminal/common/ba/regions - name: rise @@ -2439,8 +2439,8 @@ main: ref: /SDK/stocks/ba/stalker - name: trend ref: /SDK/stocks/ba/trend - - name: reddit_sent - ref: /SDK/stocks/ba/reddit_sent + - name: redditsent + ref: /SDK/stocks/ba/redditsent - name: headlines ref: /SDK/stocks/ba/headlines - name: queries