From 9be827cc239be2976e9ea24a6b35c3a834c920bb Mon Sep 17 00:00:00 2001 From: didier Date: Wed, 7 Apr 2021 01:35:53 +0100 Subject: [PATCH] improve a tidy bit some menus and stuff --- gamestonk_terminal/README.md | 14 +++---- .../cryptocurrency/crypto_controller.py | 2 +- .../portfolio/port_controller.py | 31 +++++++------- .../residuals_analysis/ra_controller.py | 2 +- gamestonk_terminal/screener/README.md | 42 +++++++++---------- .../screener/screener_controller.py | 12 +++--- 6 files changed, 50 insertions(+), 53 deletions(-) diff --git a/gamestonk_terminal/README.md b/gamestonk_terminal/README.md index 7a400499e93..46e946a0161 100644 --- a/gamestonk_terminal/README.md +++ b/gamestonk_terminal/README.md @@ -320,16 +320,16 @@ Command|Description|Source ## Screener [»](screener/README.md) Command|Description|Source ------ | --------|---- -view |view available presets +view |view available presets | [presets]((screener/presets/README.md)) set |set one of the available presets historical |view historical price |[Yahoo Finance](https://finance.yahoo.com/) [Finviz](https://finviz.com/screener.ashx) | -overview |overview information -valuation |valuation information -financial |financial information -ownership |ownership information -performance |performance information -technical |technical information +overview |overview (e.g. Sector, Industry, Market Cap, Volume) +valuation |valuation (e.g. P/E, PEG, P/S, P/B, EPS this Y) +financial |financial (e.g. Dividend, ROA, ROE, ROI, Earnings) +ownership |ownership (e.g. Float, Insider Own, Short Ratio) +performance |performance (e.g. Perf Week, Perf YTD, Volatility M) +technical |technical (e.g. Beta, SMA50, 52W Low, RSI, Change) signals |view filter signals (e.g. -s top_gainers) diff --git a/gamestonk_terminal/cryptocurrency/crypto_controller.py b/gamestonk_terminal/cryptocurrency/crypto_controller.py index e494136cea3..4a1508e11f8 100644 --- a/gamestonk_terminal/cryptocurrency/crypto_controller.py +++ b/gamestonk_terminal/cryptocurrency/crypto_controller.py @@ -29,7 +29,7 @@ class CryptoController: print(" help show this menu again") print(" q quit this menu, and shows back to main menu") print(" quit quit to abandon program") - print(f"\nCurrent Coin : {current_coin}") + print(f"\nCurrent Coin: {current_coin}") print("") print(" load load cryptocurrency data") print(" view load and view cryptocurrency data") diff --git a/gamestonk_terminal/portfolio/port_controller.py b/gamestonk_terminal/portfolio/port_controller.py index f21d0b1b97b..d6d5265789e 100644 --- a/gamestonk_terminal/portfolio/port_controller.py +++ b/gamestonk_terminal/portfolio/port_controller.py @@ -45,31 +45,32 @@ class PortfolioController: def print_help(broker_list): """ Print help """ + print("\nBrokers Supported: rh - Robinhood") + print(" alp - Alpaca") + print(" ally - Ally Invest") print("\nPortfolio:") print(" help show this menu again") print( " q quit this menu, and shows back to main menu, logs out of brokers" ) print(" quit quit to abandon program, logs out of brokers") - print(" login login to your brokers") + print( - f"\nCurrent Brokers : {('None', ', '.join(broker_list))[bool(broker_list)]}" + f"\nCurrent Broker: {('None', ', '.join(broker_list))[bool(broker_list)]}" ) - print("\nCurrently Supported :") - print(" rh Robinhood") - print(" alp Alpaca") - print(" ally Ally Invest") - print("\nCommands (login required):") + print("") + print(" login login to your brokers") + print("\nRobinhood:") - print(" rhhold view rh holdings") - print(" rhhist plot rh portfolio history") - print("\nAlpaca:") - print(" alphold view alp holdings") - print(" alphist view alp portfolio history") - print("\nAlly:") - print(" allyhold view ally holdings") + print(" rhhold view rh holdings") + print(" rhhist plot rh portfolio history") + print("Alpaca:") + print(" alphold view alp holdings") + print(" alphist view alp portfolio history") + print("Ally:") + print(" allyhold view ally holdings") print("\nMerge:") - print(" hold view net holdings across all logins") + print(" hold view net holdings across all logins") print("") def print_portfolio_menu(self): diff --git a/gamestonk_terminal/residuals_analysis/ra_controller.py b/gamestonk_terminal/residuals_analysis/ra_controller.py index 886cd9e38b5..7e35d5c1119 100644 --- a/gamestonk_terminal/residuals_analysis/ra_controller.py +++ b/gamestonk_terminal/residuals_analysis/ra_controller.py @@ -87,7 +87,7 @@ class ResidualsController: print(" normality normality test (Kurtosis,Skewness,...)") print(" goodness goodness of fit test (Kolmogorov-Smirnov)") print(" arch autoregressive conditional heteroscedasticity") - print(" unitroot Unit root test / stationarity (ADF, KPSS)") + print(" unitroot unit root test / stationarity (ADF, KPSS)") print( " independence tests independent and identically distributed (BDS)" ) diff --git a/gamestonk_terminal/screener/README.md b/gamestonk_terminal/screener/README.md index d805ade7fba..557e0181be1 100644 --- a/gamestonk_terminal/screener/README.md +++ b/gamestonk_terminal/screener/README.md @@ -9,17 +9,17 @@ This menu aims to filter stocks based on pre-specified preset filters, and the u * [historical](#historical) * view historical price [Yahoo Finance] * [overview](#overview) - * overview information [Finviz] + * overview (e.g. Sector, Industry, Market Cap, Volume) [Finviz] * [valuation](#valuation) - * valuation information [Finviz] + * valuation (e.g. P/E, PEG, P/S, P/B, EPS this Y) [Finviz] * [financial](#financial) - * financial information [Finviz] + * financial (e.g. Dividend, ROA, ROE, ROI, Earnings) [Finviz] * [ownership](#ownership) - * ownership information [Finviz] + * ownership (e.g. Float, Insider Own, Short Ratio) [Finviz] * [performance](#performance) - * performance information [Finviz] + * performance (e.g. Perf Week, Perf YTD, Volatility M) [Finviz] * [technical](#technical) - * technical information [Finviz] + * technical (e.g. Beta, SMA50, 52W Low, RSI, Change) [Finviz] * contains [Oversold (-s) signal example](#signal-oversold) * [signals](#signals) * view filter signals (e.g. -s top_gainers) [Finviz] @@ -50,7 +50,7 @@ Set preset from under presets folder. ## historical ```text -usage: historical [-t {o,h,l,c,a}] [-s {top_gainers,top_losers,...}] [--start START] +usage: historical [-t {o,h,l,c,a}] [-s {top_gainers,top_losers,...}] [--start START] ``` View historical price of stocks. [Source: Yahoo Finance] @@ -67,10 +67,10 @@ View historical price of stocks. [Source: Yahoo Finance] ## overview ```text -usage: overview [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] +usage: overview [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Sector, Industry, Market Cap, Volume. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. @@ -83,10 +83,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field ## valuation ```text -usage: valuation [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] +usage: valuation [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: P/E, PEG, P/S, P/B, EPS this Y. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. @@ -99,10 +99,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field ## financial ```text -usage: financial [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] +usage: financial [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Dividend, ROA, ROE, ROI, Earnings. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. @@ -115,10 +115,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field ## ownership ```text -usage: ownership [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] +usage: ownership [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Float, Insider Own, Short Ratio. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. @@ -131,10 +131,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field ## performance ```text -usage: performance [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] +usage: performance [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Perf Week, Perf YTD, Volatility M. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. @@ -147,11 +147,10 @@ Prints screener data of the companies that meet the pre-set filtering. The field ## technical ```text -usage: technical [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] +usage: technical [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, -ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. Some of the fields shown are: Beta, SMA50, 52W Low, RSI, Change. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. * -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. @@ -181,6 +180,3 @@ Prints list of available signals. [Source: Finviz] Captura de ecrã 2021-04-05, às 20 25 13 - - - diff --git a/gamestonk_terminal/screener/screener_controller.py b/gamestonk_terminal/screener/screener_controller.py index 40640cc6d8b..cc34b3e80ab 100644 --- a/gamestonk_terminal/screener/screener_controller.py +++ b/gamestonk_terminal/screener/screener_controller.py @@ -60,12 +60,12 @@ class ScreenerController: print(f"PRESET: {self.preset}") print("") print(" historical view historical price") - print(" overview overview information") - print(" valuation valuation information") - print(" financial financial information") - print(" ownership ownership information") - print(" performance performance information") - print(" technical technical information") + print(" overview overview (e.g. Sector, Industry, Market Cap, Volume)") + print(" valuation valuation (e.g. P/E, PEG, P/S, P/B, EPS this Y)") + print(" financial financial (e.g. Dividend, ROA, ROE, ROI, Earnings)") + print(" ownership ownership (e.g. Float, Insider Own, Short Ratio)") + print(" performance performance (e.g. Perf Week, Perf YTD, Volatility M)") + print(" technical technical (e.g. Beta, SMA50, 52W Low, RSI, Change)") print("") print(" signals view filter signals (e.g. -s top_gainers)") print("")