/Coincommand

Python command line tool for taking command of your crypto coins

Primary LanguagePythonMIT LicenseMIT

Coincommand

__author__ = "Jasper Haasdijk"
__version__ = "0.0.1"

Python command line tool for taking command of your crypto coins
Uses the coinmarketcap API

Introduction

Quickly check current crypto statistics from the ease of your terminal
Some of the current features include:

  • Get help on the usage of command line flags with the -h or --help parameter
  • Show the currently installed version by using the -v or --version parameter
  • Convert to your preferred fiat currency by using the -c flag. Valid values are:
"AUD", "BRL", "CAD", "CHF", "CLP", "CNY", "CZK", "DKK", "EUR", "GBP",
"HKD", "HUF", "IDR", "ILS", "INR", "JPY", "KRW", "MXN", "MYR", "NOK",
"NZD", "PHP", "PKR", "PLN", "RUB", "SEK", "SGD", "THB", "TRY", "TWD",
"USD", "ZAR"
  • Only display the coins that you are interested in with the -f parameter. Use this flag with a string of separated symbols. Example use is:
$ python3 main.py -f "ETH, BTC, XRP, BCH, ADA"
  • Automatically refresh the information every rate seconds by using the -r or parameter
  • Display the first top currencies by using the -t parameter
usage: main.py [-h] [-v] [-c currency] [-f list] [-r rate] [-t top]

optional arguments:
  -h, --help     show this help message and exit
  -v, --version  display version information and exit
  -c currency    convert to your preferred fiat currency
  -f list        only display your desired coins
  -r rate        automatically refresh information every <rate> seconds
  -t top         display the first <top> currencies
  • Display information about the current top 10 listings by running the tool without any options. This is the default behaviour
  • Terminal colours to make the displayed statistics nicer on the eyes
  • Don't forget you can combine flags as you please. For example if you are interested in the top 5 coins, converted to euros and refreshed every 20 minutes, you'd do:
$ python3 main.py -t 5 -c EUR -r 1200

Getting started

Install dependencies

$ pip install tabulate
$ pip install requests

Clone this repository at the desired location

$ git clone https://github.com/jhaasdijk/Coincommand.git

Move into the Coincommand folder

$ cd Coincommand

Run the utility

$ python3 main.py

Dependencies

Troubleshooting

If you run into any errors, please do not hesitate to create an issue


What's next

  • Add visual aid output. Inspiration taken from gtop and blessed
  • Add the option to load from json format to make use of a user specified configuration
  • Add the option to have user specified alerts as per their configuration