bluppfisk / coindicator

A crypto-currency (Bitcoin, Ethereum et al) market price indicator for the Linux desktop. Sits in the tray and lets you set alerts. Supports GNOME, Unity and KDE.
MIT License
159 stars 40 forks source link

Coindicator

Coin Price logo

Coindicator is a cryptocurrency price indicator applet for Linux.

PyPI version

Features

Screenshot

Installing

You will need Git and Python 3.5 or higher, as well as some system dependencies.

For your convenience, I've included a small install script that will install (or upgrade) coindicator and its dependencies, as well as create a desktop icon. It will ask to elevate permissions to install dependencies. It takes the install location as an argument.

 git clone https://github.com/bluppfisk/coindicator.git && cd coindicator
 ./install.sh /opt/coindicator  # or wherever you want it installed.

Upgrading from 1.x

User data has moved to your home folder. To keep your settings, move the user.conf file to: ~/.config/coindicator/.

Running

Configuring

Use the GUI to add and remove indicators (find the piggy icon), to pick assets, to set refresh frequency and to set alarms. Alternatively, edit the ~/.config/coindicator/user.conf YAML file.

max_decimals: default 8. Lower if you want fewer decimals (takes priority over significant_digits) significant_digits: default 3. Set to higher if you want more significant digits.

Extending (Plug-ins)

Adding your own exchange plug-in is easy. Just create class file with methods for returning a ticker URL, a discovery URL, and parsing the responses from the ticker and discovery APIs. Then add the file to the exchanges folder.

Have a peek at the existing plug-ins (e.g. kraken.py) for an example and don't forget to contribute your plug-ins here on GitHub!

Building

Troubleshooting

This software was tested and found working on the following configurations:

For other systems, you may need to install LibAppIndicator support.

Before reporting bugs or issues, please try removing/renaming the ~/.config/coindicator folder first.