Skip to main content

cryptocurrency prices on the command line

Project description

About

a cli application for displaying the current price of a cryptocurrency, designed (but not limited) to be ran in conky. cryptik supports multiple exchanges and multiple currencies.

Please see the project wiki for supported currencies and supported exchanges or to request new currencies/exchanges.

NOTICES

  • this app uses tomli for toml parsing, python 3.11 has tomllib included which we will move to at some point in the near future. We realize this could be a large burden on users so we have delayed this task until python 3.11 is more widely used.

Latest Changes

  • replaced black, flake8, isort with ruff
  • upgraded packages: types-python-dateutil
  • add modified [date] to --version & standardize version metadata
  • removed config module as it is not needed/used

Requirements

  • python3

Install

We recommend using pipx to install cryptik: pipx install cryptik. You can also install via pip: pip install --user cryptik.

cryptik uses a config file to store your setup. This file contains information such as the exchange(s) to use. You can grab the sample config file from cryptik/example/config.toml and place it in ~/.config/cryptik as this is where cryptik looks for the file by default or you can place it anywhere you like and use the --config-file parameter to specify the location.

Usage

  • call cryptik from command line: cryptik -e BITSTAMP -t BTC
    • show full response: cryptik.py -d full
  • list all available exchanges: cryptik.py -l
  • get help on cryptik: cryptik.py -h
  • example conky usage (note: this will show prices from two exchanges):
CRYPTIK
  ${texeci 600 cryptik -e KRAKEN -t BTC}
  ${texeci 600 cryptik -e BITSTAMP -t BTC}

Example Response

  • direct call:
$ cryptik -e BITSTAMP -t BTC
BTMP:BTC $9711.24 @12:33

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

cryptik-3.10.0.tar.gz (16.9 kB view hashes)

Uploaded Source

Built Distribution

cryptik-3.10.0-py3-none-any.whl (17.8 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