jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add markdownlint to all top level markdowns (#884)

Browse Source 
* Add markdownlint to all top level markdowns

* Fixing deliberate mistakes
This commit is contained in:
Artem Veremey
2021-10-30 15:00:08 -07:00
committed by GitHub
parent e00729044a
commit ceedec844b
6 changed files with 301 additions and 181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/test.yml vendored
View File

@@ -94,7 +94,7 @@ jobs:
- name: Lint Code Base
uses: docker://avtodev/markdown-lint:v1
with:
args: "./gamestonk_terminal/options/README.md ./CONTRIBUTING.md"
args: "./gamestonk_terminal/options/README.md ./*.md"
tests-python:
name: Vanilla Python Tests - (${{ matrix.python-version }}, ${{ matrix.os }})
needs: test

4
.markdownlintrc vendored
View File

@@ -4,5 +4,7 @@
"MD013": {
"line_length": 120,
"tables": false
}
},
"MD036": false,
"MD041": false
}

25
DOCKER_ADVANCED.md vendored
View File

@@ -2,10 +2,13 @@
## Environment Variables
In order to pass your API keys to the docker container, they must first be set in a local file. In the main repository, there is a file with predefined keys and terminal settings [setenv](/docker/setenv). This can be downloaded or created on your own
In order to pass your API keys to the docker container, they must first be set in a local file. In the main repository,
there is a file with predefined keys and terminal settings [setenv](/docker/setenv). This can be downloaded or created
on your own
The file should contain something such as:
```
```bash
DISPLAY=
GT_API_KEY_FINANCIALMODELINGPREP=qwerty123456
@@ -20,15 +23,18 @@ GTFF_ENABLE_THOUGHTS_DAY=False
GTFF_USE_PROMPT_TOOLKIT=True
GTFF_USE_ION=True
```
where 'qwerty123456' corresponds to each individual API key. Note:
1. Unlike API keys in [config_terminal](/gamestonk_terminal/config_terminal.py), these keys **DO NOT** use " ".
2. This file is sensible to white spaces. Therefore, make sure there isn't an additional white space at the end of the key, otherwise it won't work.
2. This file is sensible to white spaces. Therefore, make sure there isn't an additional white space at the end of the
key, otherwise it won't work.
In order to run the docker container with the environment variables, make sure to edit with whatever keys you have and
then run the container (`path/to/setenv`) should be replaced with wherever this file was created). If you have
downloaded the entire repository and your current directory is `GamestonkTerminal`, then the path would be `docker/setenv`
In order to run the docker container with the environment variables, make sure to edit with whatever keys you have and then run the container (`path/to/setenv`) should be replaced with wherever this file was created). If you have downloaded the entire repository and your current directory is `GamestonkTerminal`, then the path would be `docker/setenv`
```
```bash
docker run -it --rm --env-file=path/to/setenv ghcr.io/gamestonkterminal/gst-poetry:latest
```
@@ -36,7 +42,8 @@ docker run -it --rm --env-file=path/to/setenv ghcr.io/gamestonkterminal/gst-poet
In order to display plots in the docker container, we can configure our XServer.
Users familiar with Docker and X-Server can set the `DISPLAY` variable in the file [setenv](/docker/setenv) described above. If you use this approach remember to add `:0` at the end of your inet address. E.g. `DISPLAY=192.168.1.155:0`.
Users familiar with Docker and X-Server can set the `DISPLAY` variable in the file [setenv](/docker/setenv) described
above. If you use this approach remember to add `:0` at the end of your inet address. E.g. `DISPLAY=192.168.1.155:0`.
### X-Server
@@ -44,19 +51,21 @@ For help setting up the X-Server, I will go through this now:
#### Setting up X Quartz/X11
0. Install X Quartz from https://www.xquartz.org/
0. Install X Quartz from <https://www.xquartz.org/>
1. With X Quartz open: go to Preferences -> Security and make sure both options are enabled.
![Screen Shot 2021-09-08 at 12 21 48 PM](https://user-images.githubusercontent.com/18151143/132548605-235d774b-9aa6-4a45-afcf-58fb775d376a.png)
#### Adding the display for Docker
From the command prompt or terminal, run the following to add your local configuration to the list of allowed access control:
```bash
IP=$(ifconfig | grep inet | grep -v -e "127.0.0.1" | awk '$1=="inet" {print $2}')
xhost + $IP
```
Now we can run the docker container, adding the display to the environment:
```bach
docker run -it --rm --env-file=path/to/setenv -e DISPLAY=$IP:0 ghcr.io/gamestonkterminal/gst-poetry:latest
```

351
README.md vendored
View File

@@ -37,14 +37,18 @@
<br />
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/blob/master/ROADMAP.md"><strong>≪ ROADMAP</strong></a>
&nbsp · &nbsp
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/tree/master/gamestonk_terminal/README.md"><strong>FEATURES »</strong></a>
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/tree/master/gamestonk_terminal/README.md">
<strong>FEATURES »</strong></a>
<br />
<br />
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBug%5D">Report Bug</a>
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBug%5D">
Report Bug</a>
·
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=%5BIMPROVE%5D">Suggest Improvement</a>
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=%5BIMPROVE%5D">
Suggest Improvement</a>
·
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/issues/new?assignees=&labels=new+feature&template=feature_request.md&title=%5BFR%5D">Request Feature</a>
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/issues/new?assignees=&labels=new+feature&template=feature_request.md&title=%5BFR%5D">
Request Feature</a>
</p>
</p>
@@ -76,51 +80,63 @@
**How it started:**
Gamestonk Terminal is an awesome stock and crypto market terminal that has been developed for fun, while I saw my GME shares tanking. But hey, I like the stock 💎🙌.
Gamestonk Terminal is an awesome stock and crypto market terminal that has been developed for fun, while I saw my GME
shares tanking. But hey, I like the stock 💎🙌.
**How it's going:**
Gamestonk Terminal provides a modern Python-based integrated environment for investment research, that allows the average joe retail trader to leverage state-of-the-art Data Science and Machine Learning technologies.
As a modern Python-based environment, GamestonkTerminal opens access to numerous Python data libraries in Data Science (Pandas, Numpy, Scipy, Jupyter), Machine Learning (Pytorch, Tensorflow, Sklearn, Flair), and Data Acquisition (Beautiful Soup, and numerous third-party APIs).
Gamestonk Terminal provides a modern Python-based integrated environment for investment research, that allows
an average joe retail trader to leverage state-of-the-art Data Science and Machine Learning technologies.
As a modern Python-based environment, GamestonkTerminal opens access to numerous Python data libraries in Data Science
(Pandas, Numpy, Scipy, Jupyter), Machine Learning (Pytorch, Tensorflow, Sklearn, Flair), and Data Acquisition
(Beautiful Soup, and numerous third-party APIs).
## Getting Started
### Docker Installation - *new and improved*
0. First step is to make sure docker desktop is installed. Install links can be found [here](https://www.docker.com/products/docker-desktop). To confirm that your docker desktop is downloaded and running, open a command prompt or terminal and enter
1. First step is to make sure docker desktop is installed. Install links can be found [here](https://www.docker.com/products/docker-desktop).
To confirm that your docker desktop is downloaded and running, open a command prompt or terminal and enter
`docker info`. If you get the following you are not running the docker desktop:
```bash
Server:
ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
```
Open the docker desktop app in this case.
1. Download the latest docker image.
```bash
Server:
ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
```
```bash
docker pull ghcr.io/gamestonkterminal/gst-poetry:latest
```
Open the docker desktop app in this case.
Upon running this the first time, you should see the various layers downloading (note the random series of letters numbers will vary). The first time this is run, it will take a few minutes. Subsequent updates will be much faster, as the changes will be in the MB instead of GB.
![Screen Shot 2021-09-08 at 10 41 08 AM](https://user-images.githubusercontent.com/18151143/132531075-7d7f7e71-4fcb-435c-9bb3-466d7077eba4.png)
2. Download the latest docker image.
Once the download is complete, confirm that the image has been created by doing `docker images`. You should see something similar to
```bash
REPOSITORY TAG IMAGE ID CREATED SIZE
ghcr.io/gamestonkterminal/gst-poetry latest e2bbeebcc73c 42 hours ago 2.02GB
```
```bash
docker pull ghcr.io/gamestonkterminal/gst-poetry:latest
```
2. Run a container
Upon running this the first time, you should see the various layers downloading (note the random series of letters
numbers will vary). The first time this is run, it will take a few minutes. Subsequent updates will be much faster,
as the changes will be in the MB instead of GB.
![Screen Shot 2021-09-08 at 10 41 08 AM](https://user-images.githubusercontent.com/18151143/132531075-7d7f7e71-4fcb-435c-9bb3-466d7077eba4.png)
You are now ready to run the terminal.
Once the download is complete, confirm that the image has been created by doing `docker images`. You should see
something similar to
```docker run -it --rm ghcr.io/gamestonkterminal/gst-poetry:latest```
```bash
REPOSITORY TAG IMAGE ID CREATED SIZE
ghcr.io/gamestonkterminal/gst-poetry latest e2bbeebcc73c 42 hours ago 2.02GB
```
This will open up the terminal in your command prompt or terminal. Note that this has provided now environment file, so you will not be able to view plots or use keys at this stage.
3. Run a container
To read more on adding the environment keys and how to configure your X-server to show plots, hop over to the [Advanced Docker Setup](/DOCKER_ADVANCED.md).
You are now ready to run the terminal.
```docker run -it --rm ghcr.io/gamestonkterminal/gst-poetry:latest```
This will open up the terminal in your command prompt or terminal. Note that this has provided now environment file,
so you will not be able to view plots or use keys at this stage.
To read more on adding the environment keys and how to configure your X-server to show plots, hop over to the
[Advanced Docker Setup](/DOCKER_ADVANCED.md).
### Local Install - Anaconda and Python
@@ -128,110 +144,133 @@ If you'd like to see a video recording of the installation process, @JohnnyDanks
This project supports Python 3.7, 3.8 and 3.9.
Our current recommendation is to use this project with Anaconda's Python distribution - either full [__Anaconda3 Latest__](https://repo.anaconda.com/archive/) or [__Miniconda3 Latest__](https://repo.anaconda.com/archive/). Several features in this project utilize Machine Learning. Machine Learning Python dependencies are optional. If you decided to add Machine Learning features at a later point, you will likely have better user experience with Anaconda's Python distribution.
Our current recommendation is to use this project with Anaconda's Python distribution - either full
[__Anaconda3 Latest__](https://repo.anaconda.com/archive/) or [__Miniconda3 Latest__](https://repo.anaconda.com/archive/).
Several features in this project utilize Machine Learning. Machine Learning Python dependencies are optional.
If you decided to add Machine Learning features at a later point, you will likely have better user experience with
Anaconda's Python distribution.
0. Star the project
<img width="1272" alt="Captura de ecrã 2021-04-25, às 01 13 30" src="https://user-images.githubusercontent.com/25267873/115989986-e20cfe80-a5b8-11eb-8182-d6d87d092252.png">
<img width="1272" alt="Github starts" src="https://user-images.githubusercontent.com/25267873/115989986-e20cfe80-a5b8-11eb-8182-d6d87d092252.png">
1. [Install Anaconda](https://docs.anaconda.com/anaconda/install/index.html) (It's on the AUR as anaconda or miniconda3!)
Confirm that you have it with: `conda -V`. The output should be something along the lines of: `conda 4.9.2`
- Confirm that you have it with: `conda -V`. The output should be something along the lines of: `conda 4.9.2`
- If on Windows, install/update Microsoft C++ Build Tools from here: https://visualstudio.microsoft.com/visual-cpp-build-tools/
- If on Windows, install/update Microsoft C++ Build Tools from here: <https://visualstudio.microsoft.com/visual-cpp-build-tools/>
2. Install git
```
conda install -c anaconda git
````
```bash
conda install -c anaconda git
````
3. Clone the Project
- Via HTTPS: `git clone https://github.com/GamestonkTerminal/GamestonkTerminal.git`
- via SSH: `git clone git@github.com:GamestonkTerminal/GamestonkTerminal.git`
- Via HTTPS: `git clone https://github.com/GamestonkTerminal/GamestonkTerminal.git`
- via SSH: `git clone git@github.com:GamestonkTerminal/GamestonkTerminal.git`
4. Navigate into the project's folder
```
cd GamestonkTerminal/
```
```bash
cd GamestonkTerminal/
```
5. Create Environment
You can name the environment whatever you want. Although you could use names such as: `welikethestock`, `thisistheway` or `diamondhands`, we recommend something simple and intuitive like `gst`. This is because this name will be used from now onwards.
You can name the environment whatever you want. Although you could use names such as: `welikethestock`, `thisistheway`
or `diamondhands`, we recommend something simple and intuitive like `gst`. This is because this name will be used
from now onwards.
```
conda env create -n gst --file build/conda/conda-3-8-env.yaml
````
```bash
conda env create -n gst --file build/conda/conda-3-8-env.yaml
````
6. Activate the virtual environment
```
conda activate gst
```
```bash
conda activate gst
```
Note: At the end, you can deactivate it with: `conda deactivate`.
Note: At the end, you can deactivate it with: `conda deactivate`.
7. Install poetry dependencies
```
poetry install
```
```bash
poetry install
```
If you are having trouble with Poetry (e.g. on a Windows system), simply install requirements.txt with pip
If you are having trouble with Poetry (e.g. on a Windows system), simply install requirements.txt with pip
```
pip install -r requirements.txt
```
```bash
pip install -r requirements.txt
```
8. You're ready to Gamestonk it!
8. You're ready to Gamestonk it!
```
python terminal.py
```
```bash
python terminal.py
```
9. (Windows - Optional) Speeding up opening process in the future
After you've installed Gamestonk Terminal, you'll find a file named "Gamestonk Terminal.bat". You can use this file to open Gamestonk Terminal quicker. This file can be moved to your desktop if you'd like. If you run into issues while trying to run the batch file. If you run into issues with the batch files, edit the file and check to see if the directories match up. This file assumes you used the default directories when installing.
After you've installed Gamestonk Terminal, you'll find a file named "Gamestonk Terminal.bat". You can use this file
to open Gamestonk Terminal quicker. This file can be moved to your desktop if you'd like. If you run into issues
while trying to run the batch file. If you run into issues with the batch files, edit the file and check to see if
the directories match up. This file assumes you used the default directories when installing.
10. Jupyter Lab (Optional. Early alpha). User the Terminal from Jupyter Lab
You can install Jupyter Lab extensions that help you manage settings and launch the terminal in a JL bash console using the commands in the [jupyterlab/README.md](jupyterlab/README.md)
You can install Jupyter Lab extensions that help you manage settings and launch the terminal in a JL bash console
using the commands in the [jupyterlab/README.md](jupyterlab/README.md)
**NOTE:** When you close the terminal and re-open it, the only command you need to re-call is `conda activate gst` before you call `python terminal.py` again.
**NOTE:** When you close the terminal and re-open it, the only command you need to re-call is `conda activate gst`
before you call `python terminal.py` again.
**TROUBLESHOOT:** If you are having troubles to install, check our *newest* <a href="https://github.com/GamestonkTerminal/GamestonkTerminal/blob/master/TROUBLESHOOT.md"><strong>troubleshoot page</strong></a>
**TROUBLESHOOT:** If you are having troubles to install, check our *newest*
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/blob/master/TROUBLESHOOT.md"><strong>troubleshoot page</strong></a>
### Advanced User Install - Machine Learning
If you are an advanced user and use other Python distributions, we have several requirements.txt documents that you can pick from to download project dependencies.
If you are an advanced user and use other Python distributions, we have several requirements.txt documents that you can
pick from to download project dependencies.
If you are using conda instead of build/conda/conda-3-8-env.yaml configuration file in Step 5, use build/conda/conda-3-8-env-full.
Note: The libraries specified in the [requirements.txt](/requirements.txt) file have been tested and work for the purpose of this project, however, these may be older versions. Hence, it is recommended for the user to set up a virtual python environment prior to installing these. This allows to keep dependencies required by different projects in separate places.
Note: The libraries specified in the [requirements.txt](/requirements.txt) file have been tested and work for
the purpose of this project, however, these may be older versions. Hence, it is recommended for the user to set up
a virtual python environment prior to installing these. This allows to keep dependencies required by different projects
in separate places.
*If you would like to use optional Machine Learning features:*
* Update your [feature_flags.py](/gamestonk_terminal/feature_flags.py) with:
```
- Update your [feature_flags.py](/gamestonk_terminal/feature_flags.py) with:
```bash
ENABLE_PREDICT = os.getenv("GTFF_ENABLE_PREDICT") or True
```
* Install optional ML features dependencies:
```
- Install optional ML features dependencies:
```bash
poetry install -E prediction
```
### Update Terminal
The terminal is constantly being updated with new features and bug fixes, hence, for your terminal to be update, you can run:
```
The terminal is constantly being updated with new features and bug fixes, hence, for your terminal to be update,
you can run:
```bash
git pull
```
to get the latest changes.
If this fails due to the fact that you had modified some python files, and there's a conflict with the updates, you can use:
```
```bash
git stash
```
@@ -240,7 +279,8 @@ Then, re-run `poetry install` or `pip install -r requirements.txt` to get any n
Once installation is finished, you're ready to gamestonk.
If you `stashed` your changes previously, you can un-stash them with:
```
```bash
git stash pop
```
@@ -249,24 +289,25 @@ git stash pop
The project is build around several different API calls, whether it is to access historical data or financials.
These are the ones where a key is necessary:
* Alpha Vantage: https://www.alphavantage.co
* Binance: https://binance.us (US) / https://binance.com (Outside US)
* CoinMarketCap API: https://coinmarketcap.com/api
* Degiro API : https://www.degiro.fr
* FRED: https://fred.stlouisfed.org/docs/api/api_key.html
* Financial Modeling Prep: https://financialmodelingprep.com/developer
* Finhub API: https://finnhub.io
* News API: https://newsapi.org
* Oanda API: https://developer.oanda.com
* Polygon: https://polygon.io
* Quandl: https://www.quandl.com/tools/api
* Reddit: https://www.reddit.com/prefs/apps
* SentimentInvestor: https://sentimentinvestor.com
* Tradier: https://developer.tradier.com/getting_started
* Twitter: https://developer.twitter.com
* Coinbase Pro API: https://docs.pro.coinbase.com/
* Whale Alert API: https://docs.whale-alert.io/
* Ethplorer API: https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API
- Alpha Vantage: <https://www.alphavantage.co>
- Binance: <https://binance.us> (US) / <https://binance.com> (Outside US)
- CoinMarketCap API: <https://coinmarketcap.com/api>
- Degiro API : <https://www.degiro.fr>
- FRED: <https://fred.stlouisfed.org/docs/api/api_key.html>
- Financial Modeling Prep: <https://financialmodelingprep.com/developer>
- Finhub API: <https://finnhub.io>
- News API: <https://newsapi.org>
- Oanda API: <https://developer.oanda.com>
- Polygon: <https://polygon.io>
- Quandl: <https://www.quandl.com/tools/api>
- Reddit: <https://www.reddit.com/prefs/apps>
- SentimentInvestor: <https://sentimentinvestor.com>
- Tradier: <https://developer.tradier.com/getting_started>
- Twitter: <https://developer.twitter.com>
- Coinbase Pro API: <https://docs.pro.coinbase.com/>
- Whale Alert API: <https://docs.whale-alert.io/>
- Ethplorer API: <https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API>
When these are obtained, don't forget to update [config_terminal.py](/gamestonk_terminal/config_terminal.py).
@@ -294,12 +335,15 @@ Alternatively, you can also set them to the following environment variables:
| [Ethplorer](https://github.com/EverexIO/Ethplorer/wiki/Ethplorer-API) | GT_API_ETHPLORER_KEY |
Example:
```
```bash
export GT_API_REDDIT_USERNAME=SexyYear
```
Environment variables can also be set in a `.env` file at the top of the repo. This file is ignored by git so your API keys will stay secret. The above example stored in `.env` would be:
```
Environment variables can also be set in a `.env` file at the top of the repo. This file is ignored by git so your API
keys will stay secret. The above example stored in `.env` would be:
```bash
GT_API_REDDIT_USERNAME=SexyYear
```
@@ -309,42 +353,60 @@ Note that it is not necessary to have a valid Alpha Vantage key to get daily OHL
### Usage
Start by selecting a context that you would like to work with. If you want to research stocks, you would start with
```
```bash
stocks
```
Alternatively, you can set a default context to be loaded in the config_terminal file by setting
```
```bash
DEFAULT_CONTEXT = "stocks"
```
From this menu, you can load a ticker of interest (note the -t is optional):
```
```bash
load -t GME
```
At this point, all available menus will be in full color and available to use.
To look at the candle chart of your stock, run:
```
```bash
candle
```
Slice the historical data by loading ticker and setting a starting point, e.g.
```
```bash
load -t GME -s 2020-06-04
```
To perform technical analysis, first enter the menu
```
```bash
ta
```
and run a SMA with:
```
```bash
sma
```
However, imagine that you wanted to change the length of the window because you don't want to go long but do a swing, and therefore a smaller window is necessary. Check what settings are available on the SMA command:
```
However, imagine that you wanted to change the length of the window because you don't want to go long but do a swing,
and therefore a smaller window is necessary. Check what settings are available on the SMA command:
```bash
sma -h
```
Once that has been seen, set the parameters that you want after flagging them. In this case, to change length window to 10, we would have to do:
```
Once that has been seen, set the parameters that you want after flagging them. In this case, to change length window
to 10, we would have to do:
```bash
sma -l 10
```
@@ -352,19 +414,20 @@ Example:
<img src='/images/usage.gif' width="1000">
To return to the stocks menu to perform more research in a different menu, just use the `q` command. From the stocks menu, using `q` again will return you to the main menu where you can enter a different context (crypto for example).
To return to the stocks menu to perform more research in a different menu, just use the `q` command. From the stocks
menu, using `q` again will return you to the main menu where you can enter a different context (crypto for example).
<!-- CONTRIBUTING -->
## Contributing
There are 3 main ways of contributing to this project.
For a 1h coding session where the architecture of the repo is explained while a new feature is added, check https://www.youtube.com/watch?v=9BMI9cleTTg.
For a 1h coding session where the architecture of the repo is explained while a new feature is added, check <https://www.youtube.com/watch?v=9BMI9cleTTg>.
**Become a Contributor 🦍**
Recommended if you bought the dip, and the share price keeps dipping. You may as well keep yourself busy while stonks go up.
Recommended if you bought the dip, and the share price keeps dipping. You may as well keep yourself busy while stonks
go up.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
@@ -375,32 +438,38 @@ Recommended if you bought the dip, and the share price keeps dipping. You may as
5. Push to your Branch (`git push origin feature/AmazingFeature`)
6. Open a Pull Request
**Become a Karen 🤷**
Recommended if you adopted a strategy of buying high and selling low.
We are interested in your view on what sort of [features](https://github.com/GamestonkTerminal/GamestonkTerminal/issues) would make you buy even higher and selling even lower.
Also, if somehow you're sitting in several mils due to this terminal, don't forget to report a [bug](https://github.com/GamestonkTerminal/GamestonkTerminal/issues) so that the team can fix, and keep the old ways.
We are interested in your view on what sort of [features](https://github.com/GamestonkTerminal/GamestonkTerminal/issues)
would make you buy even higher and selling even lower.
Also, if somehow you're sitting in several mils due to this terminal, don't forget to report a
[bug](https://github.com/GamestonkTerminal/GamestonkTerminal/issues) so that the team can fix, and keep the old ways.
**Join the 🙌 💎 Gang**
If red is your favourite color, and you never sell for a loss.
If red is your favorite color, and you never sell for a loss.
Welcome to the club, and feel free to support the developers behind this amazing open-source project.
## License
Distributed under the MIT License. See [LICENSE](https://github.com/GamestonkTerminal/GamestonkTerminal/blob/main/LICENSE) for more information.
Distributed under the MIT License. See
[LICENSE](https://github.com/GamestonkTerminal/GamestonkTerminal/blob/main/LICENSE) for more information.
## Disclaimer
"A few things I am not. I am not a cat. I am not an institutional investor, nor am I a hedge fund. I do not have clients and I do not provide personalized investment advice for fees or commissions." DFV
"A few things I am not. I am not a cat. I am not an institutional investor, nor am I a hedge fund. I do not have
clients and I do not provide personalized investment advice for fees or commissions." DFV
Trading in financial instruments involves high risks including the risk of losing some, or all, of your investment amount, and may not be suitable for all investors. Before deciding to trade in financial instrument you should be fully informed of the risks and costs associated with trading the financial markets, carefully consider your investment objectives, level of experience, and risk appetite, and seek professional advice where needed. The data contained in GST is not necessarily accurate. GST and any provider of the data contained in this website will not accept liability for any loss or damage as a result of your trading, or your reliance on the information displayed.
Trading in financial instruments involves high risks including the risk of losing some, or all, of your investment
amount, and may not be suitable for all investors. Before deciding to trade in financial instrument you should be fully
informed of the risks and costs associated with trading the financial markets, carefully consider your investment
objectives, level of experience, and risk appetite, and seek professional advice where needed. The data contained in GST
is not necessarily accurate. GST and any provider of the data contained in this website will not accept liability for
any loss or damage as a result of your trading, or your reliance on the information displayed.
## Contacts
@@ -411,21 +480,20 @@ Trading in financial instruments involves high risks including the risk of losin
[James Maslek](https://www.linkedin.com/in/james-maslek-b6810186/) - jmaslek11@gmail.com
Feel free to share loss porn, memes or any questions at:
* Discord: https://discord.gg/Up2QGbMKHY
* Twitter: [@gamestonkt](https://twitter.com/gamestonkt)
- Discord: <https://discord.gg/Up2QGbMKHY>
- Twitter: [@gamestonkt](https://twitter.com/gamestonkt)
#### Contributors
* **pll_llq** and **Chavithra**: Working on JupyterLab integration. Also developed a GUI POOC.
* **jpp** : Responsible by developing `Crypto` menu.
* **northern-64bit** : Developing a discord bot for the terminal.
* **1lluz10n** and **crspy** : Working on our landing page https://gamestonkterminal.netlify.app.
* **Meghan Hone** : Managing Twitter account.
* **Chavithra** and **Deel18** : for Degiro's integration.
* **alokan** : Responsible by developing `Forex` menu.
* **Traceabl3** : By adding several preset screeners.
### Contributors
- **pll_llq** and **Chavithra**: Working on JupyterLab integration. Also developed a GUI POOC.
- **jpp** : Responsible by developing `Crypto` menu.
- **northern-64bit** : Developing a discord bot for the terminal.
- **1lluz10n** and **crspy** : Working on our landing page <https://gamestonkterminal.netlify.app>.
- **Meghan Hone** : Managing Twitter account.
- **Chavithra** and **Deel18** : for Degiro's integration.
- **alokan** : Responsible by developing `Forex` menu.
- **Traceabl3** : By adding several preset screeners.
<a href="https://github.com/GamestonkTerminal/GamestonkTerminal/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=GamestonkTerminal/GamestonkTerminal" height="276"/>
@@ -433,16 +501,15 @@ Feel free to share loss porn, memes or any questions at:
## Acknowledgments
* [VICE article - Gamestonk Terminal Is a DIY, Meme Stock Version of Bloomberg Terminal](https://www.vice.com/en/article/qjp9vp/gamestonk-terminal-is-a-diy-meme-stock-version-of-bloomberg-terminal)
* [Daily Fintech article - Never underestimate Bloomberg, but here are 5 reasons why the Gamestonk Terminal is a contender](https://dailyfintech.com/2021/02/25/never-underestimate-bloomberg-but-here-are-5-reasons-why-the-gamestonk-terminal-is-a-contender/)
* [HackerNews - Show HN: Can’t afford Bloomberg Terminal? No prob, I built the next best thing ](https://news.ycombinator.com/item?id=26258773)
* [Reddit r/algotrading - Gamestonk Terminal: The next best thing after Bloomberg Terminal.](https://www.reddit.com/r/algotrading/comments/m4uvza/gamestonk_terminal_the_next_best_thing_after/)
* [Reddit r/Python - Gamestonk Terminal: The equivalent to an open-source python Bloomberg Terminal.](https://www.reddit.com/r/Python/comments/m515yk/gamestonk_terminal_the_equivalent_to_an/)
* [Reddit r/Superstonk - Move over Bloomberg Terminal, here comes Gamestonk Terminal](https://www.reddit.com/r/Superstonk/comments/mx2cjh/move_over_bloomberg_terminal_here_comes_gamestonk/)
* [Spotlight: Didier Lopes. Creator of Gamestonk Terminal](https://deepsource.io/spotlight/didier-lopes/)
* [Reddit r/Superstonk - Gamestonk Terminal - We are very much alive](https://www.reddit.com/r/Superstonk/comments/o502i8/gamestonk_terminal_we_are_very_much_alive/)
* [Medium- Gamestonk Terminal. Can't Stop, Won't Stop](https://dro-lopes.medium.com/gamestonk-terminal-cant-stop-won-t-stop-e635662d6f2e)
- [VICE article - Gamestonk Terminal Is a DIY, Meme Stock Version of Bloomberg Terminal](https://www.vice.com/en/article/qjp9vp/gamestonk-terminal-is-a-diy-meme-stock-version-of-bloomberg-terminal)
- [Daily Fintech article - Never underestimate Bloomberg, but here are 5 reasons why the Gamestonk Terminal is a contender](https://dailyfintech.com/2021/02/25/never-underestimate-bloomberg-but-here-are-5-reasons-why-the-gamestonk-terminal-is-a-contender/)
- [HackerNews - Show HN: Can’t afford Bloomberg Terminal? No prob, I built the next best thing](https://news.ycombinator.com/item?id=26258773)
- [Reddit r/algotrading - Gamestonk Terminal: The next best thing after Bloomberg Terminal.](https://www.reddit.com/r/algotrading/comments/m4uvza/gamestonk_terminal_the_next_best_thing_after/)
- [Reddit r/Python - Gamestonk Terminal: The equivalent to an open-source python Bloomberg Terminal.](https://www.reddit.com/r/Python/comments/m515yk/gamestonk_terminal_the_equivalent_to_an/)
- [Reddit r/Superstonk - Move over Bloomberg Terminal, here comes Gamestonk Terminal](https://www.reddit.com/r/Superstonk/comments/mx2cjh/move_over_bloomberg_terminal_here_comes_gamestonk/)
- [Spotlight: Didier Lopes. Creator of Gamestonk Terminal](https://deepsource.io/spotlight/didier-lopes/)
- [Reddit r/Superstonk - Gamestonk Terminal - We are very much alive](https://www.reddit.com/r/Superstonk/comments/o502i8/gamestonk_terminal_we_are_very_much_alive/)
- [Medium- Gamestonk Terminal. Can't Stop, Won't Stop](https://dro-lopes.medium.com/gamestonk-terminal-cant-stop-won-t-stop-e635662d6f2e)
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

70
ROADMAP.md vendored
View File

@@ -38,12 +38,14 @@
---
## 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)
@@ -51,42 +53,48 @@
* [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] 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)
@@ -95,38 +103,40 @@
**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)
@@ -135,6 +145,7 @@
---
## 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)
@@ -144,11 +155,10 @@
**NEXT**
---
## Exploratory Data Analysis
* [x] Summary statistics, cdf, histogram, box-whiskers, cusum, decompose (@didier) - [PR #289](https://github.com/DidierRLopes/GamestonkTerminal/pull/289)
**NEXT**
@@ -156,12 +166,16 @@
---
## 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)
* [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)
@@ -171,37 +185,43 @@
* [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)
@@ -212,11 +232,13 @@ ___
---
## 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)
---
@@ -224,29 +246,34 @@ ___
## 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 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] 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)
@@ -257,24 +284,26 @@ ___
---
## 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)
* [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**
@@ -282,6 +311,7 @@ ___
---
## 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)
@@ -289,15 +319,19 @@ ___
**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
@@ -307,6 +341,7 @@ ___
---
## 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)
@@ -316,14 +351,16 @@ ___
---
## 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] 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
@@ -337,6 +374,7 @@ ___
* [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

30
TROUBLESHOOT.md vendored
View File

@@ -2,7 +2,9 @@
If you are visiting this page it means that you're having issues installing. We deeply apologize for that.
Since the start of the project we've come across different types of issues experienced by the users. This page tries to combine issues, and their solutions. This will allow to give the best install experience to everyone regardless of any programming skills.
Since the start of the project we've come across different types of issues experienced by the users. This page tries to
combine issues, and their solutions. This will allow to give the best install experience to everyone regardless of any
programming skills.
<ol>
<li>
@@ -39,8 +41,9 @@ Since the start of the project we've come across different types of issues exper
### Microsoft Visual C++
If your terminal has too many red error lines, it is likely that this is the issue. Go to this page and install the c++ build tools:
https://answers.microsoft.com/en-us/windows/forum/windows_other-windows_install/microsoft-visual-c-140/6f0726e2-6c32-4719-9fe5-aa68b5ad8e6d
If your terminal has too many red error lines, it is likely that this is the issue. Go to this page and install the c++
build tools:
<https://answers.microsoft.com/en-us/windows/forum/windows_other-windows_install/microsoft-visual-c-140/6f0726e2-6c32-4719-9fe5-aa68b5ad8e6d>
### Wheel
@@ -48,13 +51,13 @@ https://answers.microsoft.com/en-us/windows/forum/windows_other-windows_install/
### Cvxpy
```
```bash
conda install -c conda-forge cvxpy
```
### Numpy
```
```bash
pip install --upgrade numpy==1.20.2
```
@@ -78,7 +81,8 @@ If you run into trouble with Poetry, and the advice above did not help, your bes
2. `conda deactivate` -> `conda activate gst`, then try again
3. Track down the offensive package and purge it from your anaconda `<environment_name>` folder, then try again (removing through conda can sometimes leave locks behind)
3. Track down the offensive package and purge it from your anaconda `<environment_name>` folder, then try again
(removing through conda can sometimes leave locks behind)
| Platform | Location |
| --------- | -------------------------------------------- |
@@ -108,19 +112,19 @@ Please note that the package `pmdarima` needs to installed through `pip install`
### pypfopt
```
```bash
pip install PyPortfolioOpt
```
### dotenv
```
```bash
pip install python-dotenv
```
### ally
```
```bash
pip install pyally
```
@@ -128,7 +132,7 @@ pip install pyally
If you run into issues installing or `Cannot convert a symbolic Tensor...` at runtime, try this:
```
```bash
conda install -c conda-forge numpy=1.19.5 hdf5=1.10.5
poetry install
poetry install -E prediction
@@ -150,14 +154,14 @@ important that you change this setting to LF _before_ you make any changes to th
It is possible that CRLF automatically turns back on, you can correct this with:
```
```bash
git config --global core.autocrlf false
```
In case you already made coding adjustments, you have to reset your cache, and the changes you made to the code with
the following:
```
```bash
git rm --cached -r .
git reset --hard
```
@@ -168,6 +172,6 @@ Occurs when vscode terminal python version/path is different from the terminal v
To fix it add this to vscode JSON settings ([ref](https://stackoverflow.com/questions/54582361/vscode-terminal-shows-incorrect-python-version-and-path-launching-terminal-from)):
```
```bash
"terminal.integrated.inheritEnv": false,
```