Skip to main content

A CLI crypto prices tracker.

Project description

Draham

screenshot

Installation

Getting started with draham is very simple. Just install the package via pip

pip install --user draham

Usage

Because draham pulls its data from the CoinMarketCap API, you will unfortuneraly need to create a developer account and generate an API KEY. The basic plan is free and affords you 10K calls per month.

draham requires a configuration file in the ini format. By default it will look for a .drahamrc file under your home directory.

Here's how it should look like

[auth]
api_key=your_api_key_without_quotes

other (optional) settings include symbols and currency.

[options]
; default symbols are: BTC,BCH,DASH,LTC,ETH,XMR,XRP,BNB
; symbols must be separated by a comma. Quotes are not allowed.
symbols=BTC,ETH,BCH

; default currency is: USD
currency=USD

Command line options

  • --tor - Use tor as a proxy before reaching the API
  • --detailed - Get a more detailed view of the prices (1h price change, 24h volume, total circulating supply)
  • --config - specify a path to a custom config file (default is $HOME/.drahamrc)

Currently, draham supports the following currencies:

  • 🇩🇿 Algerian Dinar (DZD)
  • 🇺🇸 US Dollar (USD)
  • 🇬🇧 British Pound (GBP)
  • 🇪🇺 Euro (EUR)
  • 🇦🇺 Australian Dollar (AUD)
  • 🇨🇦 Canadian Dollar (CAD)
  • 🇯🇵 Japanese Yen (JPY)

License

This project is distributed under the WTFPL public license.

Issues and Contributing

Contributions to draham are most welcome. If you encounter bugs, please report them via issues. You can of course submit fixes and new features via of merge requests.

If you fork this project on GitHub, I kindly ask you that you credit me as the original creator of the project.

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

draham-1.0.1.tar.gz (5.5 kB view hashes)

Uploaded Source

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