From 5784dde7da2dec4fc84b97df0ae171e7b905cbe4 Mon Sep 17 00:00:00 2001 From: Jamie Date: Fri, 21 May 2021 20:45:59 -0400 Subject: [PATCH] Start Readme --- gamestonk_terminal/etf/README.md | 31 +++++++++++++++++++ gamestonk_terminal/etf/stockanalysis_model.py | 2 +- 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 gamestonk_terminal/etf/README.md diff --git a/gamestonk_terminal/etf/README.md b/gamestonk_terminal/etf/README.md new file mode 100644 index 00000000000..d998f368a1a --- /dev/null +++ b/gamestonk_terminal/etf/README.md @@ -0,0 +1,31 @@ +# ETF +Menu for Exchange Traded Funds. + +Data is currently scraped from StockAnalysis.com/etf + +* [web](#web) + * open webbroswer to stockanalysis.com +* [search](#search) + * search for ETFS matching an input +* [overview](#overview) + * get ETF overview +* [holdings](#holdings) + * show ETF holdings +* [compare](#compare) + * compare multiple ETFs overview + +## web +```python +usage: web +``` +Opens StockAnalysis.com/etf. This site shows all avalaiable ETFs (currently > 2800). + +## search +```python +usage: search [-n --name] +``` +Search for ETFs matching +* -n/--name : Name to search for. Can be a company or other + + + diff --git a/gamestonk_terminal/etf/stockanalysis_model.py b/gamestonk_terminal/etf/stockanalysis_model.py index 09f72b71171..fb1088f6e6f 100644 --- a/gamestonk_terminal/etf/stockanalysis_model.py +++ b/gamestonk_terminal/etf/stockanalysis_model.py @@ -36,7 +36,7 @@ def open_web(): def name_search(other_args: List[str]): """ - Search all available etfs for matching + Search all available etfs for matching input Parameters ---------- other_args: List[str]