Skip to main content

Terminal utility that can track stocks, cryptocurrencies, forexes, and more. Built with Python and urwid.

Project description

stonktrack

GitHub release (latest by date) PyPI GitHub Python Version

Stonktrack is a terminal utility that can track stocks, cryptocurrencies, forexes, and more. Built with Python and urwid, it's different from other terminal finance trackers in that it can track a variety of assets, fetches non-delayed real-time data, and does not require an API key. Stocktrack can also automatically convert prices into your local currency.

Getting Started

Installing and Running

This program can be installed in two different ways. You can install it directly with pip (recommended), or clone the repository and run the code yourself. Either way, you will need Python 3.6 or higher to run the code.

Using Pip

$ pip3 install stonktrack
$ nano config.yml
$ python3 -m stonktrack

Manually

$ git clone https://github.com/slightlyskepticalpotat/stonktrack.git
$ cd stonktrack
$ pip3 install -r requirements.txt
$ nano config.yml
$ python3 stonktrack.py

Usage

Stonktrack is configured through a single configuration file named config.yml. Configuration options are explained in CONFIG.md, and a sample configuration file is provided in config.yml.

Screenshots

More screenshots of various options are available in /screenshots.

stonktrack

Normal stonktrack, with colour and a scrollbar


stonktrack-bw

Monochrome mode is less distracting for some


stonktrack-focus

The focus tab displays in-depth stats


stonktrack-phone

Stonktrack works on mobile (Android + Termux)

Contributing

Bug reports, forks, and pull requests are all welcome. Feel free to open an issue!

Licence

This project is licensed under the GNU Affero General Public License v3.0, and makes use of other open-source libraries. For more information, please refer to our LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stonktrack-1.4.1.tar.gz (22.2 kB view hashes)

Uploaded Source

Built Distribution

stonktrack-1.4.1-py3-none-any.whl (22.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page