stock-terminal

Stock quote terminal using Finnhub API

Compatibility

Works with Linux, macOS, and Windows. Requires Python 3.7 or later.

Usage

Clone the repo

git clone https://github.com/Adobe-Android/stock-terminal.git

Prepare the virtual environment

Install virtualenv if it is not already installed or use the Python 3.5+ venv.

python -m pipx install virtualenv

If you do not have pipx installed, either install it with pip (command below) or first install pipx.

python -m pip install --user virtualenv

Go to the project directory.

cd stock-terminal

Next, we can actually create our virtual environment inside of our newly cloned directory.

virtualenv env

Activate the virtual environment using the appropriate files for our environment. I'll include commands for the most common scenarios below. More information can be found here

Bash (macOS, Linux, or other Unix)

source bin/activate

PowerShell (Windows)

.\env\Scripts\Activate.ps1

Command Prompt (Windows)

.\env\Scripts\activate.bat

Install the necessary packages

python -m pip install -r requirements.txt

Setup finnhub.io API Token

Go login/signup on the finnhub.io dashboard and get yourself an API token. Then create a .env file at the root of the project with the following:

export X_Finnhub_Token=YOUR_API_TOKEN_HERE

Run

python -m ticker.py

Example

Congratulations! You've reached the end of the instructions.

Additional Notes

The program expects to read from a file in the same directory as the Python script named tickers.txt. You can add up to 30 tickers total. This is a limitation set in the program to avoid the API defined 30 API calls per second limit. You can increase or decrease the refresh_cycle variable in the program but this can cause you to experience API rate limiting even if you are below the 30 ticker total. See finnhub.io

Libraries

• Rich

References

• https://realpython.com/python-virtual-environments-a-primer/

• https://learnpython.com/blog/how-to-use-virtualenv-python/

• https://www.freecodecamp.org/news/how-to-setup-virtual-environments-in-python/

Troubleshooting (Install pipx)

python -m pip install --user -U pipx
python -m pipx ensurepath

Troubleshooting (Windows)

If you are having trouble on Windows specifically, I'd suggest you clean out the following directories. I've found these issues to be common when you've maintained a Windows install long enough to have downloaded at least a few Python versions over time, even if you only have the latest installed now.

C:\Users\tngam\.local - delete bin and pipx folders
C:\Users\tngam\AppData\Roaming\Python - delete all folders

If you are on macOS or Linux, you probably aren't having these sorts of problems, but feel free to open an issue.