Stonks is a simple command-line stock market checker.
It basically fetches stock market data using Yahoo Finance, and displays your favorite tickers informations in the command prompt.
You can also set the amount of shares you own for any ticker, and Stonks will calculate your daily profit and loss (P&L).
Stonks uses a configuration file named .stonks.cfg
in order to work. If the file does not exist, Stonks will automatically create it.
You can edit the config file at any time, just save the file and restart Stonks to apply your changes.
Inside the config file you are also allowed to edit the minimum refresh delay between updates, and also the preferred currency that you want to use in P&L and Balance calculations.
By setting enable-debug-mode
to True
, the software will show the Debug Mode section:
You can easily exit the program at any time using Ctrl+C
.
The main python script is located in stonks/stonks.py
An example config is located in stonks/.stonks.cfg