Output a cryptocurrency price ticker to stdout based on the configuration found, by default, in ~/.quicktick . Options can be provided at the command line to override any part of the ticker configuration.

quicktick requires Python 3.6, or newer, and can be installed using pip :

Configuration

The configuration is a YAML file, which will be created in your home directory on first run (if it doesn’t already exist), which defines the default ticker, how to output price data and how data sources are defined. Jinja2 templating is used to make this very adaptable to your needs.

The default configuration only defines a data source for the CoinMarketCap API with support for:

Cryptocurrencies: Bitcoin

Bitcoin Cash

Ethereum

Litecoin Fiat currencies: US Dollars

Euros

Chinese Yuan

British Pounds Price data: Exchange rate

Change in the last hour

CoinMarketCap’s API supports many more options and these can be added to your configuration, as needed. Alternatively, other JSON-based HTTP APIs can be defined as data sources.

Ticker The default ticker is defined under the ticker section in the configuration. It takes four attributes: source The data source to use, defined in the sources section. crypto The cryptocurrency symbol to use, as defined by the source . fiat The fiat currency symbol to use, as defined by the source . template The template to use to render the ticker, defined in the templates section (n.b., this must be a predefined template; a raw Jinja2 template string can only be used at the command line).

Templates The templates section is used to define named Jinja2 templates. By default, there is simple and ansi (which is the same as simple , with ANSI escape sequences used for colour output). When the templates are rendered, they have access to three sets of data: fiat The fiat currency symbol (see Data Sources for details). crypto The cryptocurrency symbol (see Data Sources for details). Price data The price data variables returned by the data source (see Data Sources for details).