Big UX improvement (#1041)

Co-authored-by: jmaslek <jmaslek11@gmail.com>
Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Didier Rodrigues Lopes <dro.lopes@campus.fct.unl.pt>

* improve user experience phase 1

* add difflib replacement

* implement auto-complete on discovery menu

* auoto-complete, difflib,jump through menus with cd

* Updating tests : terminal

* improve navigation on gst

* add q command to terminal.py

* usage instructions

* Updating tests : terminal

* fix cd command

* vars updated

* show menu when user is going through menus

* allow user to forget the intiail / on scripting

* terminal to accept text file with configuration

* refactor -n to -l and clean code

* add all commands to the tests_stocks_disc

* remove fds from disc since we have search on stocks/ and stocks/sia

* hopefully fix tests

* skip test

* fix completer type and calling menu after command for stocks/disc

* show help menu when moving forward/backwards in menus

* skip test

* skip test - bug fix

* add reset, help and quit to choices

* improve stocks/disc controller

* refactor sia menu

* UX improvements for sia menu

* improve ux design

* refactor ca controller

* fix infinite loop

* improve ux on dps controller

* Add capability of going back from a menu going into a menu

* Ux economy (#1056)

* First round of UX improvements on economy menu

* Do fred menu + sample tests file

* revert to > on menu

* rename jobs file to .gst

* remove cd option

* improve return

* final refactoring of disc_controller

* fix ca,dps,sia,disc,stocks and terminal controllers

* work on ba_controller menu

* fix reset and try_except

* UX on screener controller

* fix for full reset name

* Ux etfs (#1059)

* Refactor ETF menu for new UX

* Add couple more examples to test

* r->reset

* Clean up switch

* gov menu refactored

* fix reset issue

* 80% of refactoring options and pricing/payoff menu is done

* improve payoff controller

* minor fix

* fix: refactor pred and ta stocks controller

* fix: refactor fa(and fmp) controllers

* fix: refactored dd controller (still missing .gst tests)

* fix infinite loop bug

* refactor options controller

* add tests for payoff and pricing

* fix reset for options

* UX Upgrade for Crypto controller(s) (#1049)

* refactor crypto controller

* refactor crypto/defi controller

* added simple test and fixes not returning queue in commands

* Clean up unused functions / iex load (#1047)

* Clean up unused functions and adjust iex load function to not depend on dates

* Had an incorrect tab on s_start definition

* wrong default arg

* regenerate pytest yml

* Comment out parametrization

* Tests : Stocks > Discovery (#1050)

* Updating tests : stocks/discovery/ark

* Updating tests : stocks/discovery/fidelity

* Updating tests : stocks/discovery/fidelity

* Updating tests : stocks/discovery/fidelity

* Updating tests : stocks/discovery/seeking_alpha

* Updating tests : stocks/discovery/seeking_alpha

* Updating tests : stocks/discovery/shortinterest

* Updating tests : stocks/discovery/shortinterest

* Updating tests : stocks/discovery/seeking_alpha

* Updating tests : stocks/discovery/shortinterest

* Updating tests : stocks/discovery/disc_controller

* Updating tests : stocks/dd

* Updating tests : stocks/fa

* Updating tests : stocks/discovery/financedatabase

* Updating tests : stocks/discovery/finnhub

* Updating tests : stocks/discovery/geekofwallstreet

* Updating tests : stocks/discovery/marketbeat

* Updating tests : stocks/discovery/nasdaq

* Updating tests : stocks / discovery / yahoofinance

* Updating tests : black

* Updating tests : unused import

* Updating tests : stocks/discovery/ark

* Tests : Stocks > Doc + Helpers + Government (#1051)

* Updating tests : stocks/government/controller

* Updating tests : stocks/government

* Updating tests : conftest

* Updating tests : stocks > government

* Updating tests : stocks/government

* Updating tests : docs

* Tests : Stocks > Insider (#1054)

* Updating tests : stocks > helper

* Updating tests : doc

* Updating tests : clean stocks > fa > av

* Updating tests : stocks/insider/controller

* Updating tests : stocks/insider/business insider

* Updating tests : stocks/insider/finviz

* Updating tests :  stocks/insider/openinsider

* Updating tests :  stocks/insider/controller

* Updating tests : black

* Updating tests : stocks/insider/controller

* Tests : Stocks > Backtesting + Behavioural Analysis  (#1057)

* Updating tests : add __init__ files

* Updating tests : stocsk/behavioural_analysis

* Updating tests : black

* Updating tests : stocks/backtesting

* Updating tests : stocks/backtesting

* fix: converted top to limit arguments

* fix: refactor disc controller, updated docs

* fix: refactor dd_controller and docs

* fix: refactor nft controller and docs

* fix: pass test temporarily, onchain controller refactor, docs

* fix: overview controller refactor, fix quit command

* fix: linting issues

* fix: refacot ta controller

* fix: refactor pred controller

* fix: linting

* fix: crypto controller

* fix: added tests, updated all controlers

* fix: menu print renamed from stocks to crypto controller, added tests

* fix: fix faster function execution

* Fix annoying pylint C0201 error

* fix: renamed commands to long format

* DISC Cleanup (#1058)

* Get rid/cleanup of marketbeat functions

* Get rid of last unused disc function + fix related tests

* fix test

* Dividend History Chart (#1053)

* Dividend History Chart

* changed to default number 10

* changed divs flag default to false

* updating the expected result for test_fa_controller.

* else statement

* fix: added load on dd

* fix: added autocompletion in all commands with argument choices

* fix: linting

* Workflows + Stocks > Insider (#1061)

* Updating code : stocks/insider remove unused file

* Updating workflows : tests - set mypy==0.910

* fix: linting

* Fixing Linting (#1062)

* Updating code : fixing linting

mypy message = Too many arguments for <lambda>

* Updating workflows : allow newest mypy version

* Updating code : apply black

* Updating code : black

* fix: updated predict controller help to match stocks

* Ux: portfolio (#1063)

* First step of portfolio UX

* Add all broker controllers to UX stuff

* UX Improvement for PO

Co-authored-by: Didier Rodrigues Lopes <dro.lopes@campus.fct.unl.pt>

* UX Improvement for resources (#1064)

Co-authored-by: Didier Rodrigues Lopes <dro.lopes@campus.fct.unl.pt>

* UX: stock/bt (#1065)

* UX: stocks>qa (#1068)

* fix mypy lambda

* skip tests for now

* remove unused paths.py

* rename tests/simulator to tests/e2e

* refactor options/screener menu

* UX : move `gst` files location

* fix stocks_controller

* UX upgrade of the Forex menu (#1048)

* Add basic forex menu test

* Add forex routes to terminal paths

* Remove commands from paths because they're not menus

* WIP Refactor forex controller

* refactor crypto controller

* Remove commented code

* Improve user output with printed text

* Add "help" back to the list of choices

* Enable the command queue for the forex controller

* refactor crypto/defi controller

* Fix candle chart blocking the terminal

* Black

* Return help and reset to the list of known args

* added simple test and fixes not returning queue in commands

* Add currency codes loading to the av_model

* Return the queue in edge cases (when commands don't process)

* Split select into to and from to enable autocompletion

* Style text output

* Stop printing help after the execution of every command

* Update test scenarios

* Black

* fix: converted top to limit arguments

* fix: refactor disc controller, updated docs

* Delete oanda the old view file that was moved into the oanda menu

* fix: refactor dd_controller and docs

* fix: refactor nft controller and docs

* fix: pass test temporarily, onchain controller refactor, docs

* fix: overview controller refactor, fix quit command

* fix: linting issues

* fix: refacot ta controller

* fix: refactor pred controller

* fix: linting

* fix: crypto controller

* fix: added tests, updated all controlers

* fix: menu print renamed from stocks to crypto controller, added tests

* fix: fix faster function execution

* Implement basic UX improvement of the oanda controller

* Update the forex controller

* Fix annoying pylint C0201 error

* Add latest convention changes to the forex controller

* fix: renamed commands to long format

* fix: added load on dd

* Merge the latest updates of the controller design

* fix: added autocompletion in all commands with argument choices

* fix: linting

* fix: linting

* fix: updated predict controller help to match stocks

* Update the forex menu e2e test scripts

* Add check_non_negative_float helper

* Update the controller with the latest changes to the convention

* Update the currency pair loading mechanism

* Move data models logic to the models file

* Update update oanda views to be interact with the models

* Upgrade oanda controller

* Remove raw stocks ba and eda code from the forex menu

* Update "help wanted" banner for ba and eda in forex menu

* Remove remainders of stocks ba and eda from forex context

* Improve typing, docstrings and error messages

* Remove stocks ba and eda code that was merged from other ux branches

* Add fixes that prevented incorrect argument handling

* Remove -argument from the candles call
If there is an expected agr `-g` and you put an incorrect argument
`-argument` the difflib will interpret `argument` as `g`

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: Didier Rodrigues Lopes <dro.lopes@campus.fct.unl.pt>

* fix reset for menus that require ticker

* UX improvement on research menu

* skip insider controller test

* initial refactoring of insider_controller

* improve insider controller ux part 2

* finish refactoring ins controller ux menu

* fix bug of when commands in queue have args

* skip test

* comment test stuff

* UX: stocks>qa (#1071)

* refactor return self.queue

* fix return None

* minor fix

* minor tabulate fix

* Get rid of leading '/' in terminal and add some newlines on quits. (#1074)

* Get rid of leading '/' in terminal and add some newlines on quits.

* print crypto help on menu entry

* looks like a format issue here...

* newlines on quit

* remove unnecessary line break

* fix pylint issue

* refactor

* refactor

* allow portfolio optimization to quit context

* add exit at end of scripts

* improve dd_controller

* test ux in stocks/dd menu

* Ux upgrade for reports context (#1075)

* Refactor reports and upgrade them with the latest controller convention

* Add test scenarios for the reports context

* test ux stocks/ta

* ux branch scripts/ta

* improvement on main param

* Upgrades for the UX upgrade for the fa and fa/fmp menus (#1076)

* Change --num to --limit

* Remove inconsistent/unreliable functions from the choices list

* Improve docstring compliance with numpy doc format

* Fix hardcoded class id in dcf scrapper

* Fix annoying pylint error in discordbot that was blocking the hook

* Add test scenarios for the fa and fa/fmp menus

* Fix forgotten replacement of --num to --limit

* Fix tests

* Return some excluded commands to the choices list

* Fix dd report to reflect the updates

* Fix set function not returning the queue

* Update gst test files

* fix exit on ca from another submenu

* fix changes of options/screener

* fix dps controller

* fix fa when running out of AV calls

* Fix TVL plot locking interpreter during defi test

* Add exception handling for broken coingecko scrapper

* skip fa/av test that fails

* fix dps tests

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: jmaslek <jmaslek11@gmail.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>

scripts/test_crypto_dd.gst

@@ -0,0 +1,13 @@
+crypto
+load btc
+dd
+info
+market
+ath
+atl
+web
+social
+score
+dev
+bc
+exit

scripts/test_crypto_defi.gst

@@ -0,0 +1,14 @@
+crypto
+defi
+llama
+tvl
+newsletter
+dpi
+funding
+borrow
+lending
+tokens
+stats
+pools
+swaps
+exit

scripts/test_crypto_disc.gst

@@ -0,0 +1,10 @@
+crypto
+disc
+coins btc -l 3
+cgtrending
+cgvoted
+cgvisited
+cgvolume
+cggainers
+cpsearch bitcoin
+exit

scripts/test_crypto_nft.gst

@@ -0,0 +1,7 @@
+crypto
+nft
+today
+upcoming
+ongoing
+newest
+exit

scripts/test_crypto_onchain.gst

@@ -0,0 +1,6 @@
+crypto
+onchain
+gwei
+top
+ueat
+exit

scripts/test_crypto_ov.gst

@@ -0,0 +1,8 @@
+crypto
+ov
+cbpairs
+cgnft
+cgexchanges
+cghold
+news
+exit

scripts/test_crypto_pred.gst

@@ -0,0 +1,5 @@
+crypto
+load btc
+pred
+rnn
+exit

scripts/test_crypto_ta.gst

@@ -0,0 +1,6 @@
+crypto
+load btc
+ta
+ema
+bbands
+exit

scripts/test_econ_fred.gst

@@ -0,0 +1,14 @@
+economy
+bigmac -c USA,GBR
+meats
+q
+economy
+grains
+fred
+add dgs10,dgs5
+search gdp
+plot --raw
+q
+energy
+reset
+exit

scripts/test_etf.gst

@@ -0,0 +1,12 @@
+etf
+gainers
+decliners
+active
+q
+etf
+reset
+search blackrock
+holdings qqq -l 5
+overview spy
+compare spy,qqq
+exit

scripts/test_forex_av.gst

@@ -0,0 +1,14 @@
+forex
+load -h
+load -i
+to EUR
+quote -h
+quote -argument
+quote
+load
+candle
+from ILS
+quote
+load
+candle
+exit

scripts/test_forex_base.gst

@@ -0,0 +1,13 @@
+forex
+h
+help
+?
+q
+forex
+..
+forex
+quit
+forex
+r
+reset
+exit

scripts/test_forex_oanda.gst

@@ -0,0 +1,61 @@
+forex
+oanda -h
+oanda -argument
+oanda
+from -h
+from -argument
+from usd
+to -h
+to -argument
+to chf
+price -h
+price -argument
+price
+from eur
+price
+from ils
+price
+summary -h
+summary
+from usd
+to chf
+orderbook -h
+orderbook
+list -h
+list
+order
+order -h
+order -argument
+order -u 3 -p 0.8
+list
+cancel
+cancel -h
+cancel -argument
+cancel -i
+cancel -i 5
+positions
+positions -h
+positions -argument
+pending
+pending -h
+pending -argument
+trades
+trades -h
+trades -argument
+closetrade
+closetrade -h
+closetrade -argument
+closetrade -i 5
+candles
+candles -h
+candles -v
+candles -a -b -c -e -v
+calendar
+calendar -h
+calendar -argument
+from eur
+to jpy
+calendar
+to gbp
+calendar
+exit

scripts/test_forex_oanda_base.gst

@@ -0,0 +1,14 @@
+forex
+oanda
+h
+help
+?
+q
+oanda
+..
+..
+forex
+oanda
+quit
+oanda
+exit

scripts/test_port.gst

@@ -0,0 +1,17 @@
+portfolio
+bro
+ally
+q
+degiro
+quit
+..
+po
+select aapl,msft,sbux,gme
+equal
+maxsharpe -p 1y -v 1000000 --pie
+reset
+select aapl,msft,sbux,gme
+add ge,tsla
+equal
+mktcap
+exit

scripts/test_reports.gst

@@ -0,0 +1,5 @@
+reports
+econ_dta
+econ_data
+due_diligence tsla
+exit

scripts/test_reports_base.gst

@@ -0,0 +1,17 @@
+reports
+h
+help
+?
+q
+repors
+..
+repots
+..
+reports
+quit
+reports
+r
+reset
+home
+reports
+exit

scripts/test_stocks_ba.gst

@@ -0,0 +1,27 @@
+stocks
+ba
+load aapl
+headlines
+stats
+wsb
+watchlist
+popular
+spac_c
+spac
+getdd
+bullbear
+messages
+trending
+stalker
+infer
+sentiment
+mentions
+regions
+queries
+rise
+popularsi
+emerging
+metrics
+social
+historical
+exit

scripts/test_stocks_ca.gst

@@ -0,0 +1,24 @@
+stocks
+sia
+metric roa
+ca
+historical
+hcorr
+volume
+income
+balance
+cashflow
+sentiment
+scorr
+overview
+valuation
+financial
+ownership
+performance
+technical
+ticker -t tsla
+tsne
+getpoly
+getfinnhub
+getfinviz
+exit

scripts/test_stocks_dd.gst

@@ -0,0 +1,13 @@
+stocks
+load aapl
+dd
+analyst
+rating
+rot
+pt
+est
+sec
+supplier
+customer
+arktrades
+exit

scripts/test_stocks_disc.gst

@@ -0,0 +1,32 @@
+stocks
+disc
+q
+disc
+..
+disc
+quit
+disc
+help
+h
+?
+rtearn
+pipo
+fipo
+gainers
+losers
+ugs -l 3
+gtech
+active
+ulc
+asc
+ford
+arkord
+upcoming
+trending
+cnews
+lowfloat
+hotpenny
+rtat
+reset
+r
+exit

scripts/test_stocks_dps.gst

@@ -0,0 +1,14 @@
+stocks
+dps
+shorted
+hsi
+pos
+sidtc
+load -t gme
+dpotc
+spos
+psi
+volexch
+ftd
+prom
+exit

scripts/test_stocks_fa.gst

@@ -0,0 +1,72 @@
+stocks
+load aa
+fa
+data -h
+mgmt -h
+analysis -h
+info -h
+shrs -h
+sust -h
+cal -h
+web -h
+hq -h
+divs -h
+overview -h
+key -h
+income -h
+balance -h
+cash -h
+data
+mgmt
+analysis
+info
+shrs
+sust
+cal
+web
+hq
+divs
+divs -l 8
+divs --limit 24 --plot
+overview
+key
+income
+income -l 3
+balance
+cash
+load aal
+data
+mgmt
+analysis
+info
+shrs
+sust
+cal
+web
+hq
+divs
+divs --limit 8
+overview
+key
+income
+income --limit 6
+balance
+cash
+load goog
+data
+mgmt
+analysis
+info
+shrs
+sust
+cal
+web
+hq
+divs
+divs --limit 24 -p
+overview
+key
+income
+balance
+cash
+exit

scripts/test_stocks_fa_base.gst

@@ -0,0 +1,20 @@
+stocks
+load aapl
+fa
+h
+help
+?
+q
+fa
+..
+..
+stocks
+load aa
+fa
+quit
+fa
+home
+stocks
+load aal
+fa
+exit

scripts/test_stocks_fa_fmp.gst

@@ -0,0 +1,38 @@
+stocks
+load aa
+fa
+fmp
+profile -h
+quote -h
+enterprise -h
+dcf -h
+income -h
+balance -h
+cash -h
+metrics -h
+ratios -h
+growth -h
+profile
+quote
+enterprise
+dcf
+income
+balance
+cash
+metrics
+ratios
+growth
+..
+load aapl
+fmp
+profile
+quote
+enterprise
+dcf
+income
+balance
+cash
+metrics
+ratios
+growth
+exit

scripts/test_stocks_fa_fmp_base.gst

@@ -0,0 +1,21 @@
+stocks
+load aapl
+fa
+fmp
+h
+help
+?
+q
+fmp
+..
+..
+fa
+fmp
+quit
+fmp
+home
+stocks
+load aal
+fa
+fmp
+exit

scripts/test_stocks_gov.gst

@@ -0,0 +1,14 @@
+stocks
+gov
+lasttrades
+topbuys
+topsells
+lastcontracts
+qtrcontracts
+toplobbying
+load aapl
+gtrades
+contracts
+histcont
+lobbying
+exit

scripts/test_stocks_ins.gst

@@ -0,0 +1,31 @@
+stocks
+ins
+view
+view whales
+set whales
+filter
+load aapl
+stats
+act
+lins
+lcb 3
+lpsb 3
+lit 3
+lip 3
+blip 3
+blop 3
+blcp 3
+lis 3
+blis 3
+blos 3
+blcs 3
+topt 3
+toppw 3
+toppm 3
+tipt 3
+tippw 3
+tippm 3
+tist
+tispw
+tispm 3
+exit

scripts/test_stocks_options.gst

@@ -0,0 +1,24 @@
+stocks
+options
+screen
+view
+view high_IV
+set high_IV
+scr
+q
+unu
+calc
+load aapl
+exp 0
+pcr
+info
+chains
+oi
+vol
+voi
+hist 100
+grhist 100
+plot -x ltd -y iv
+parity
+binom
+exit

scripts/test_stocks_options_payoff.gst

@@ -0,0 +1,13 @@
+stocks
+options
+load aapl
+exp 0
+payoff
+list
+pick long
+add 20
+add 15
+add 10 -p
+sop
+plot
+exit

scripts/test_stocks_options_pricing.gst

@@ -0,0 +1,13 @@
+stocks
+options
+load aapl
+exp 0
+pricing
+add 150 -c 3
+rmv 150
+add 150 -c 0.3
+add 170 -c 0.5
+add 180 -c 0.2
+show
+rnval
+exit

scripts/test_stocks_options_screen.gst

@@ -0,0 +1,10 @@
+stocks
+options
+screen
+view
+view high_IV
+set high_IV
+scr
+ca
+historical
+exit

scripts/test_stocks_pred.gst

@@ -0,0 +1,14 @@
+stocks
+load aapl
+pred
+pick Close
+ets
+knn
+regression
+arima
+mlp
+rnn
+lstm
+conv1d
+mc
+exit

scripts/test_stocks_qa.gst

@@ -0,0 +1,30 @@
+stocks
+load aapl
+qa
+summary
+load gme
+normality
+unitroot
+..
+q
+stocks
+load amzn
+qa
+hist
+cdf
+pick Volume
+bw
+acf
+qqplot
+pick AdjClose
+rolling -l 10
+load gme
+spread
+quantile
+skew
+kurtosis
+raw
+decompose
+cusum
+capm
+exit

scripts/test_stocks_scr.gst

@@ -0,0 +1,15 @@
+stocks
+scr
+view
+view rosenwald
+set top_losers
+historical
+overview
+valuation
+financial
+ownership
+performance
+technical
+ca
+hcorr
+exit

scripts/test_stocks_sia.gst

@@ -0,0 +1,33 @@
+stocks
+sia
+q
+sia
+..
+sia
+quit
+sia
+help
+h
+?
+clear
+load tsla
+clear industry
+clear sector
+clear sector
+clear country
+clear mktcap
+exchange
+exchange
+mktcap Large
+country United States
+industry Financial Data & Stock Exchanges
+cps
+cpic
+cpis
+cpcs
+cpci
+sama
+metric roa
+reset
+r
+exit

scripts/test_stocks_ta.gst

@@ -0,0 +1,27 @@
+stocks
+load aapl
+ta
+view
+recom
+ema
+sma
+wma
+hma
+zlma
+vwap
+cci
+macd
+rsi
+stoch
+fisher
+cg
+adx
+aroon
+bbands
+donchian
+kc
+ad
+adosc
+obv
+fib
+exit