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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file stonktrack-1.4.1.tar.gz.

File metadata

  • Download URL: stonktrack-1.4.1.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.5.0.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for stonktrack-1.4.1.tar.gz
Algorithm Hash digest
SHA256 db511b91d3be753fdb05c4930bddd7efdab95be310f506c36ffc5ab2ff1e536a
MD5 443a245eabed7f58bd120f202ff8f516
BLAKE2b-256 527ba0b02b65935bc2ac378b319b4eaeaed0e2033449325963c08f94149f12d3

See more details on using hashes here.

File details

Details for the file stonktrack-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: stonktrack-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 22.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.5.0.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for stonktrack-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3518995d549b437ccf421cfe6d9f3f46d02466fe1ab742906463d474a8902226
MD5 e1a4182802d05dab907acdfa6b9d6ae2
BLAKE2b-256 472057d77caeeb1fec45ef834a3444f06feedbb4fdde07034368335269d4057e

See more details on using hashes here.

Supported by

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