Add demo and remove roadmap (#1434)

* add gst letters only

* this roadmap was very misleading

* Update README.md

* Update README.md

* have bot toc closed by default
This commit is contained in:
didierlopes.eth
2022-03-04 01:01:10 +00:00
committed by GitHub
parent 33de5e2b87
commit 2b839f609f
14 changed files with 77 additions and 390 deletions

3
README.md vendored
View File

@@ -33,8 +33,9 @@
</a>
<h3 align="center">Gamestonk Terminal 🚀</h3>
<p align="center">Click on the gif below for a DEMO of the terminal.</p>
![honest work](https://user-images.githubusercontent.com/25267873/148552707-12dcca7e-0b7e-481c-9055-17436c2bc4cf.gif)
[![honest work](https://user-images.githubusercontent.com/25267873/148552707-12dcca7e-0b7e-481c-9055-17436c2bc4cf.gif)](https://www.youtube.com/watch?v=fqGPK8OVHLk)
<p align="center">
Investment research for everyone.

383
ROADMAP.md vendored
View File

@@ -1,383 +0,0 @@
# Roadmap 📍
## Table of contents
* [Main Menu](#Main-Menu)
* [Discovery](#Discovery)
* [Behavioral Analysis](#Behavioral-Analysis)
* [Sell-side Equity Research](#Sell-side-Equity-Research)
* [Fundamental Analysis](#Fundamental-Analysis)
* [Technical Analysis](#Technical-Analysis)
* [Due Diligence](#Due-Diligence)
* [Prediction Techniques](#Prediction-Techniques)
* [Reports](#Reports)
* [Comparison Analysis](#Comparison-Analysis)
* [Exploratory Data Analysis](#Exploratory-Data-Analysis)
* [Residual Analysis](#Residual-Analysis)
* [Portfolio Analysis](#Portfolio-Analysis)
* [Brokers](#Brokers)
* [Portfolio Optimization](#Portfolio-Optimization)
* [Economy](#Economy)
* [Options](#Options)
* [Credit Analysis](#Credit-Analysis)
* [Cryptocurrencies](#Cryptocurrencies)
* [Screener](#Screener)
* [Forex](#Forex)
* [Backtesting](#Backtesting)
* [Resource Collection](#Resource-Collection)
* [Government](#Government)
* [ETF](#ETF)
## Additional
* [Backend](#Backend)
* [Frontend](#Frontend)
* [Developer Experience](#Developer-Experience)
* [User Experience](#User-Experience)
---
## Main Menu
* [x] Add about us command (@didier) - [PR #506](https://github.com/DidierRLopes/GamestonkTerminal/pull/506)
* [x] Add git commit hash to welcome message (@didier) - [PR #506](https://github.com/DidierRLopes/GamestonkTerminal/pull/506)
**NEXT**
## Discovery
* [x] Top Losers (@didier) - [PR #171](https://github.com/DidierRLopes/GamestonkTerminal/pull/171)
* [x] ARK orders (@aia) - [PR #140](https://github.com/DidierRLopes/GamestonkTerminal/pull/140)
* [x] Analyse sectors/industry performance, overview and valuation from Finviz (@didier) - [PR #315](https://github.com/DidierRLopes/GamestonkTerminal/pull/315)
* [x] Add latest and trending news commands (@hinxx) - [PR #347](https://github.com/DidierRLopes/GamestonkTerminal/pull/347)
* [x] Add top ratings updates (@hinxx) - [PR #357](https://github.com/DidierRLopes/GamestonkTerminal/pull/357)
* [x] Add dark pool (ATS) data of tickers with growing trades activity (@didier) - [PR #372](https://github.com/DidierRLopes/GamestonkTerminal/pull/372)
* [x] Past and future IPOs calendar (@didier) - [PR #432](https://github.com/DidierRLopes/GamestonkTerminal/pull/432)
* [x] Short volume and dark pool short information (stockgrid) (@jmaslek) - [PR #496](<https://github.com/GamestonkTerminal/GamestonkTerminal/pull/496>
* [x] Combine topdark onto darkshort cmd (@didier) - [PR #505](https://github.com/DidierRLopes/GamestonkTerminal/pull/505)
**NEXT**
---
## Behavioral Analysis
* [x] Add FinBrain sentiment from news (@didier) - [PR #223](https://github.com/DidierRLopes/GamestonkTerminal/pull/223)
* [x] Sentiment stats from Finnhub (@didier) - [PR #433](https://github.com/DidierRLopes/GamestonkTerminal/pull/433)
**NEXT**
* [ ] Implement a better Twitter client (@aia)
* [ ] Add Stocktwits (@aia)
---
## Sell-side Equity Research
* [x] Add stockanalysis to research menu - [PR #185](https://github.com/DidierRLopes/GamestonkTerminal/pull/185)
**NEXT**
* [ ] Add logic to Equity pull data from Bank of America, Charles Schwab
---
## Fundamental Analysis
* [x] Rearrange FA menu to have AV and FMP as submenus (@didier) - [PR #166](https://github.com/DidierRLopes/GamestonkTerminal/pull/166)
* [x] Add Fundamental Analysis score (@didier) - [PR #383](https://github.com/DidierRLopes/GamestonkTerminal/pull/383)
**NEXT**
* [ ] Add Treasury Yield Curve data (@aia) - [PR #281](https://github.com/DidierRLopes/GamestonkTerminal/pull/281)
---
## Technical Analysis
* [x] Add initial implementation of trendline analysis (@aia) - [PR #173](https://github.com/DidierRLopes/GamestonkTerminal/pull/173)
* [x] Add technical summary report provided by FinBrain (@didier) - [PR #294](https://github.com/DidierRLopes/GamestonkTerminal/pull/294)
* [x] Add recommendation based on technical indicators from Tradingview (@didier) - [PR #301](https://github.com/DidierRLopes/GamestonkTerminal/pull/301)
* [x] Add view of stock historical price with trendlines (support, resistance) by Finviz (@didier) - [PR #317](https://github.com/DidierRLopes/GamestonkTerminal/pull/317)
* [x] Add auto-recognition of major TA patterns (@didier) - [PR #429](https://github.com/DidierRLopes/GamestonkTerminal/pull/429)
**NEXT**
---
## Due Diligence
* [x] Add dark pools (ATS) vs Non-ATS data over time (@didier) - [PR #363](https://github.com/DidierRLopes/GamestonkTerminal/pull/363)
* [x] Add failure to deliver command (@hinxx) - [PR #366](https://github.com/DidierRLopes/GamestonkTerminal/pull/366)
* [x] Ratings over time (@didier) - [PR #431](https://github.com/DidierRLopes/GamestonkTerminal/pull/431)
* [x] Add short volume from stockgrid (@jmaslek) - [PR #496](https://github.com/GamestonkTerminal/GamestonkTerminal/pull/496)
* [x] Add darkpos command (@didier) - [PR #507](https://github.com/DidierRLopes/GamestonkTerminal/pull/507)
**NEXT**
---
## Prediction Techniques
* [x] Add several exponential smoothing techniques (@didier) - [PR #132](https://github.com/DidierRLopes/GamestonkTerminal/pull/132)
* [x] Allow backtesting (@didier) - [PR #169](https://github.com/DidierRLopes/GamestonkTerminal/pull/169)
* [x] Add averaging around multiple predictions (@didier) - [PR #252](https://github.com/DidierRLopes/GamestonkTerminal/pull/252)
* [x] CNN 1D (@jmaslek) - [PR #436](https://github.com/GamestonkTerminal/GamestonkTerminal/pull/436)
**NEXT**
* [ ] Combine Sentiment Analysis with Chart data - [IS #240](https://github.com/DidierRLopes/GamestonkTerminal/issues/240)
* [ ] Cross-Validation methods (Forward Chaining, K-Fold, Group K-Fold) (@didier)
---
## Reports
* [x] Add Economy analysis report (@aia) - [PR #205](https://github.com/DidierRLopes/GamestonkTerminal/pull/205)
**NEXT**
* [ ] Expand Due Diligence report (@aia)
* [ ] Add multi-ticker comparison report (@aia)
* [ ] Add interest rate analysis to Economy report (@aia)
* [ ] Add a report for major business categories - growth vs value, cyclicals, small-cap vs large-caps (@aia)
---
## Comparison Analysis
* [x] Add multi-ticker historical data comparison (@didier) - [PR #141](https://github.com/DidierRLopes/GamestonkTerminal/pull/141)
* [x] Add multi-ticker financials comparison (@didier) - [PR #237](https://github.com/DidierRLopes/GamestonkTerminal/pull/237)
* [x] Add multi-ticker sentiment comparison (@didier) - [PR #250](https://github.com/DidierRLopes/GamestonkTerminal/pull/250)
* [x] Get similar companies from Finviz based on Industry and Sector (and possibly country) from Finviz (@didier) - [PR #323](https://github.com/DidierRLopes/GamestonkTerminal/pull/323)
* [x] Output brief screen (overview, performance, financial, valuation) across similar companies (@didier) - [PR #323](https://github.com/DidierRLopes/GamestonkTerminal/pull/323)
* [x] Add command to take tickers to portfolio optimization (@jmaslek) - [PR #329](https://github.com/DidierRLopes/GamestonkTerminal/pull/329)
**NEXT**
---
## Exploratory Data Analysis
* [x] Summary statistics, cdf, histogram, box-whiskers, cusum, decompose (@didier) - [PR #289](https://github.com/DidierRLopes/GamestonkTerminal/pull/289)
**NEXT**
---
## Residual Analysis
* [x] Residuals analysis menu with histogram, qqplot, acf, hypothesis tests (e.g. Kurtosis, Jarques-Bera, ARCH, ADF)
(@didier) - [PR #292](https://github.com/DidierRLopes/GamestonkTerminal/pull/292)
**NEXT**
---
## Brokers
* [x] Add alpaca (@jmaslek) - [PR #259](https://github.com/DidierRLopes/GamestonkTerminal/pull/229)
* [x] Add robinhood (@jmaslek) - [PR #229](https://github.com/DidierRLopes/GamestonkTerminal/pull/229)
* [x] Add Ally Invest (@jmaslek) - [PR #267](https://github.com/DidierRLopes/GamestonkTerminal/pull/267)
* [x] Degiro support (@deel) - [PR #381](https://github.com/DidierRLopes/GamestonkTerminal/pull/381)
* [x] Degiro improvement (@Chavithra) - [PR #445](https://github.com/DidierRLopes/GamestonkTerminal/pull/381)
* [x] Brokers to be the old portfolio menu (@didier) - [PR #505](https://github.com/DidierRLopes/GamestonkTerminal/pull/505)
* [x] Refactor degiro menu onto a folder (@didier) - [PR #505](https://github.com/DidierRLopes/GamestonkTerminal/pull/505)
**NEXT**
* [ ] Merge data from different brokers
* [ ] Add more options around merged portfolios
* [ ] Add Brokers (td, webull, etc)
* [ ] Allow to go directly onto Portfolo Analysis
---
## Portfolio Analysis
* [x] Add custom csv integration (jmaslek) - [PR #502](https://github.com/GamestonkTerminal/GamestonkTerminal/pull/502)
* [x] Commands ported to brokers menu (@didier) - [PR #505](https://github.com/DidierRLopes/GamestonkTerminal/pull/505)
**NEXT**
* [ ] Port to new Broker Menu
* [ ] Refactoring
* [ ] Summaries / tear sheets (potentially QuantStats)
* [ ] Add plots for `group` functions
* [ ] Add more functionality for custom portfolio viewing (suggested XRay)
---
## Portfolio Optimization
* [x] Basic Optimization through PyPortFolioOpt(@jmaslek) - [PR #329](https://github.com/DidierRLopes/GamestonkTerminal/pull/329)
* [x] Add command to maximise the quadratic utility(@didier) - [PR #349](https://github.com/DidierRLopes/GamestonkTerminal/pull/349)
* [x] Allow to remove ticker from list (@didier) - [PR #505](https://github.com/DidierRLopes/GamestonkTerminal/pull/505)
**NEXT**
* [ ] Allow for more custom optimization constrains
---
## Economy
* [x] Implement Economic data (gpd, unemployment rate, ...) (@jmaslek) - [PR #167](https://github.com/DidierRLopes/GamestonkTerminal/pull/167)
* [x] Refactor FRED to ECON menu and add VIX view (@jmaslek) - [PR #405](https://github.com/DidierRLopes/GamestonkTerminal/pull/405)
* [x] Output economic impact events calendar (@didier) - [PR #430](https://github.com/DidierRLopes/GamestonkTerminal/pull/430)
* [x] Add CNN Fear and Greed Index (@didier) - [PR #509](https://github.com/DidierRLopes/GamestonkTerminal/pull/509)
**NEXT**
---
## Options
* [x] Add Volume graph (@lolrenx) - [PR #209](https://github.com/DidierRLopes/GamestonkTerminal/pull/209)
* [x] Add Open Interest graph (@lolrenx) - [PR #209](https://github.com/DidierRLopes/GamestonkTerminal/pull/209)
* [x] Add options information data (IV rank, etc) (@jmaslek) - [PR #375](https://github.com/DidierRLopes/GamestonkTerminal/pull/375)
**NEXT**
* [ ] Add max pain graph (@lolrenx)
---
## Credit Analysis
**NEXT**
* [ ] Add FINRA
* [ ] Moodies data
---
## Cryptocurrencies
* [x] Add Coingecko (@jmaslek) - [PR #283](https://github.com/DidierRLopes/GamestonkTerminal/pull/283)
* [x] Add top coins from CG (@jmaslek) [PR #428](#https://github.com/DidierRLopes/GamestonkTerminal/pull/428)
* [x] view top coins from coinmarketcap (@jmaslek) - [PR #378](https://github.com/DidierRLopes/GamestonkTerminal/pull/378)
* [x] Add binance (@jmaslek) [PR #428](#https://github.com/DidierRLopes/GamestonkTerminal/pull/428)
* [x] Add crypto ta (@jmaslek) [PR #452](https://github.com/GamestonkTerminal/GamestonkTerminal/pull/452)
**NEXT**
* [ ] Add [Coinpaprika](https://coinpaprika.com/api/)
* [ ] Add top altcoin lists
---
## Screener
* [x] Add Screener menu with overview, valuation, financial, ownership, performance, technical commands based on filter
presets from Finviz (@didier) - [PR #314](https://github.com/DidierRLopes/GamestonkTerminal/pull/314)
* [x] Add README with explanation of how presets are stored and can be added by experienced users. (@didier) - [PR #314](https://github.com/DidierRLopes/GamestonkTerminal/pull/314)
* [x] Add screener signals (e.g. top gainers, new highs, most volatile, oversold, major news, ...) from Finviz
(@didier) - [PR #314](https://github.com/DidierRLopes/GamestonkTerminal/pull/314)
* [x] Plot screener historical using Yahoo Finance data (@didier) - [PR #319](https://github.com/DidierRLopes/GamestonkTerminal/pull/319)
* [x] Add command to take tickers to portfolio optimization (@didier) - [PR #349](https://github.com/DidierRLopes/GamestonkTerminal/pull/349)
* [x] Add flags to save screeners and run papermill on returned tickers (@alokan) - [PR #414](https://github.com/DidierRLopes/GamestonkTerminal/pull/414)
* [x] Add several new screener presets (@Traceabl3) - [PR #447](https://github.com/DidierRLopes/GamestonkTerminal/pull/447)
**NEXT**
---
## Forex
* [x] Add entire forex menu through Oanda (@alokan) - [PR #360](https://github.com/DidierRLopes/GamestonkTerminal/pull/360)
* [x] Add EDA menu, Behavioural Analysis menu, Due Diligence from other users in Reddit, and latest news regarding
currency provided. (@alokan) - [PR #387](https://github.com/DidierRLopes/GamestonkTerminal/pull/387)
**NEXT**
---
## Resource Collection
* [x] Add hfletters and learn commands to resource collection (@didier) - [PR #427](https://github.com/DidierRLopes/GamestonkTerminal/pull/427)
* [x] Add arxiv, finra, edgar, fred (@didier) - [PR #438](https://github.com/DidierRLopes/GamestonkTerminal/pull/438)
**NEXT**
---
## Backtesting
* [x] Add simple backtest menu with simple strategies and benchmarks (@jmaslek) [PR #415](https://github.com/DidierRLopes/GamestonkTerminal/pull/415)
**NEXT**
---
## Government
* [x] Add congress data (@didier) [PR #438](https://github.com/DidierRLopes/GamestonkTerminal/pull/438)
* [x] Add senate and house data (@didier) [PR #446](https://github.com/DidierRLopes/GamestonkTerminal/pull/446)
* [x] Add government contracts (@didier) [PR #453](https://github.com/DidierRLopes/GamestonkTerminal/pull/453)
**NEXT**
---
## ETF
* [x] Add ETF data (@jmaslek) [PR #454](https://github.com/GamestonkTerminal/GamestonkTerminal/pull/454)
**NEXT**
---
## Backend
**NEXT**
* [ ] Logging (@aia)
* [ ] Secure storage of credentials (@aia)
* [ ] Add caching
* [ ] APIs
* [ ] GraphQL
---
## Frontend
* [x] Add terminal flair (@aia) - [PR #131](https://github.com/DidierRLopes/GamestonkTerminal/pull/131)
* [x] Prompt-toolkit (@ricleal) - [PR #142](https://github.com/DidierRLopes/GamestonkTerminal/pull/142)
* [x] Add thought of the day (@aia) - [PR #233](https://github.com/DidierRLopes/GamestonkTerminal/pull/233)
**NEXT**
---
## Developer Experience
* [x] Add Windows CI (@aia) - [PR #151](https://github.com/DidierRLopes/GamestonkTerminal/pull/151)
* [x] Add Feature Flags (@aia) - [PR #158](https://github.com/DidierRLopes/GamestonkTerminal/pull/158)
* [x] Add ad-hoc builds (@aia) - [PR #192](https://github.com/DidierRLopes/GamestonkTerminal/pull/192)
* [x] Add test generators and test parametrization helpers (@aia) - [PR #264](https://github.com/DidierRLopes/GamestonkTerminal/pull/264)
* [x] Sphinx documentation <https://gamestonk-terminal.readthedocs.io/en/latest/index.html> (@piiq) - [PR #413](https://github.com/DidierRLopes/GamestonkTerminal/pull/413)
* [x] Re-write main menu terminal to have same class struct as remaining modules (@didier) - [PR #507](https://github.com/DidierRLopes/GamestonkTerminal/pull/507)
**NEXT**
* [ ] Write a developer guide
* [ ] Add a docker CI
* [ ] Reorganize tests to separate Unit and Integration
* [ ] Versioning
---
## User Experience
* [x] Add reset command to allow update API keys (@didier) - [PR #440](https://github.com/DidierRLopes/GamestonkTerminal/pull/440)
* [x] Add update command to automatically update terminal (@didier) - [PR #441](https://github.com/DidierRLopes/GamestonkTerminal/pull/441)
**NEXT**
* [ ] Publish Docker
* [ ] Most commands to have export flag to save output into csv/txt file
* [ ] Most commands to have save flag to save image into png/jpg file
* [ ] Add a WHL installation
---

View File

@@ -1,3 +1,9 @@
Due Dilligence Commands will display with autocomplete doing most of the work.
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
Due Dilligence Commands will display with autocomplete doing most of the work.
![Screen Shot 2022-02-26 at 11 35 57 AM](https://user-images.githubusercontent.com/85772166/155856719-d0a44453-50f5-4210-ad53-a6e0cb9310bc.png)

View File

@@ -1,3 +1,9 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
disc - These discovery commands are prefixed with, disc.
![Screen Shot 2022-02-28 at 12 32 40 PM](https://user-images.githubusercontent.com/85772166/156054407-2a9e26eb-daa7-4927-895a-3b39115db775.png)

View File

@@ -1,3 +1,9 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
Dark Pool Shorts Commands are prefixed with "dps".
![Screen Shot 2022-02-26 at 4 27 43 PM](https://user-images.githubusercontent.com/85772166/155863356-dca27415-af5a-4605-bb63-e8a22a290426.png)

View File

@@ -1,3 +1,9 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
Economy commands can be browsed by clicking on the GameStonksBot avatar and scrolling down. Commands are prefixed with, econ.
![Screen Shot 2022-02-27 at 12 52 39 PM](https://user-images.githubusercontent.com/85772166/155899467-5bd8d3ce-72f7-435f-9b64-4c998bf00204.png)

View File

@@ -1,3 +1,9 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
ETF Commands are prefixed with, /etf.
![Screen Shot 2022-02-28 at 7 53 49 AM](https://user-images.githubusercontent.com/85772166/156014497-841865d7-1f06-47ba-9b67-bb16544651ad.png)

View File

@@ -1,4 +1,9 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
Government Commands (USA Only) share a common prefix of, gov.
![Screen Shot 2022-02-27 at 9 24 35 AM](https://user-images.githubusercontent.com/85772166/155892705-1025b697-dbdd-43d6-96e4-7e73f17a2439.png)

View File

@@ -1,3 +1,9 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
misc - Miscellaneous commands with no defined prefix.
![Screen Shot 2022-02-28 at 7 36 37 PM](https://user-images.githubusercontent.com/85772166/156100124-5833ab5f-ca6d-4062-9b4a-46597197dace.png)

View File

@@ -1,3 +1,9 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
Options commands can be browsed by clicking on the avatar after entering a slash. For options on indexes, use the appropriate index symbol to retrieve options data.
![Screen Shot 2022-02-24 at 12 10 44 PM](https://user-images.githubusercontent.com/85772166/155599840-343e2b7b-110f-4e95-bc43-987c5a3362cb.png)

View File

@@ -1,5 +1,11 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
This group of commands are the primary methods for requesting price information, using the symbol and exchange structures followed by yFinance. Crypto, FX, Indexes, and Futures are also callable wherever the input variable is a ticker.
A list of supported exchanges can be downloaded here:
A list of supported exchanges can be downloaded here:
[yFinance_global_exchanges.csv](https://github.com/deeleeramone/GamestonkTerminal/files/8135106/yFinance_global_exchanges.csv)

View File

@@ -1,3 +1,9 @@
The Stock Screener is a versatile screener. Sorting and various combinations will make for interesting results.
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
The Stock Screener is a versatile screener. Sorting and various combinations will make for interesting results.
![Screen Shot 2022-02-25 at 8 44 20 AM](https://user-images.githubusercontent.com/85772166/155753648-a18314df-c0fa-41f3-8f29-18b60cadd0f1.png)

View File

@@ -1,4 +1,9 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
sia - Sector and industry analysis commands are prefixed with, sia.
![Screen Shot 2022-02-28 at 12 22 41 PM](https://user-images.githubusercontent.com/85772166/156053209-290af088-92ef-42cb-bab5-ca2eaf332837.png)

View File

@@ -1,4 +1,9 @@
---
geekdocCollapseSection: true
---
{{< toc-tree >}}
Technical Analysis features can be browsed by clicking on the avatar for GameStonksBot after ending a slash.
https://user-images.githubusercontent.com/85772166/155637808-06ce25c2-d466-41e6-b84b-8f65091c9406.mov