Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexanderepstein/cryptowatch

:bird: Cryptocurrency price and account balance monitor
https://github.com/alexanderepstein/cryptowatch

cryptocurrencies cryptocurrency lcd monitoring raspberry-pi terminal

Last synced: 24 days ago
JSON representation

:bird: Cryptocurrency price and account balance monitor

Host: GitHub
URL: https://github.com/alexanderepstein/cryptowatch
Owner: alexanderepstein
License: mit
Created: 2017-08-28T21:15:37.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2022-12-07T23:43:50.000Z (almost 2 years ago)
Last Synced: 2024-09-28T10:22:09.949Z (about 1 month ago)
Topics: cryptocurrencies, cryptocurrency, lcd, monitoring, raspberry-pi, terminal
Language: Python
Homepage:
Size: 109 KB
Stars: 294
Watchers: 23
Forks: 40
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Cryptowatch

#### Monitor prices and account balances for multiple cryptocurrencies
#### Use either the terminal or Raspberry Pi LCD for monitoring

![PythonVer](https://img.shields.io/pypi/pyversions/cryptowatch.svg)
[![PyPI](https://img.shields.io/pypi/v/cryptowatch.svg)](https://pypi.python.org/pypi/cryptowatch) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/7d2ec7a555ef4534bbf42150f87ccb5d)](https://www.codacy.com/app/alexanderepstein/cryptowatch?utm_source=github.com&utm_medium=referral&utm_content=alexanderepstein/cryptowatch&utm_campaign=Badge_Grade) ![platform](https://img.shields.io/badge/platform-macOS%2C%20Linux%20%26%20Windows-blue.svg) [![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=plastic)]()

### Console Monitor

[![cryptowatch.png](https://s18.postimg.org/tx081mpq1/cryptowatch.png)](https://postimg.org/image/rsfv0jo39/)

## Install

### Pip Install

```bash
pip3 install cryptowatch
```

### Snap Package Install

```bash
sudo snap install cryptowatch
```
Snap package maintained by: [Marcin Mikołajczak](https://github.com/m4sk1n)
## Usage
```
usage: Cryptowatch [-h] [-m MONITOR] [-f FILE] [-c] [-v]

Track prices and account balances for bitcoin, ethereum, litecoin, bitcoin cash and dash

optional arguments:
-h, --help show this help message and exit
-m MONITOR, --monitor MONITOR
Choose which cryptowatch monitor to use
-f FILE, --file FILE Output the current cryptowatch data to the specified
file path
-c, --config Edit the config file for cryptowatch
-v, --version Display the current version of cryptowatch
```

##### Terminal Monitor ```cryptowatch --monitor terminal```

##### Print Information To Terminal Once ```cryptowatch```

##### Output information to a file ```cryptowatch -f desiredFilePath```

##### Display the raspberry pi monitor ```cryptowatch --monitor rpi```

##### Edit the config file ```cryptowatch --config```

## Getting Started

* First install cryptowatch

* Then run
```bash
cryptowatch --config
```
this will create a config file if one does not exist and edit it.
* The file can be found
* Windows: ```C:/.crypto.cfg```
* macOS/Linux: ```~/.crypto.cfg```

* Write in the addresses you want to track next to their respective variable, if more then one address for a type of crypto separate them with commas and a space after the comma

* Save and close the file and now you are ready to use cryptowatch!

The above steps help with getting address balance monitoring, cryptowatch still works without these steps

## Programmatic Usage

#### [CryptoUtils Documentation](https://github.com/alexanderepstein/cryptowatch/blob/master/cryptoUtils/README.md)

#### [CryptoPie Documentation](https://github.com/alexanderepstein/cryptowatch/blob/master/cryptoPie/README.md)

## Dependencies
* Python 3
* requests
* Adafruit-GPIO
* terminaltables
* colorclass

## Todo
- [x] Change from curses interface to a table
- [x] Color the terminal output
- [ ] Support more cryptocurrencies

## Donate
If this project helped you in any way and you feel like supporting me

[![Donate](https://img.shields.io/badge/Donate-Venmo-blue.svg)](https://venmo.com/AlexanderEpstein)
[![Donate](https://img.shields.io/badge/Donate-SquareCash-green.svg)](https://cash.me/$AlexEpstein)

###### BTC: 38Q5VbH63MtouxHu8BuPNLzfY5B5RNVMDn
###### ETH: 0xf7c60C06D298FF954917eA45206426f79d40Ac9D
###### LTC: LWZ3T19YUk66dgkczN7dRhiXDMqSYrXUV4
###### DSH: XpV1LtM5PvpfR9z5pYFZVmgcpLkDmrFAKM
###### XRP: r4ZsnoHM94zMb2SCJ89fYzQqmGgozqLZF1
###### XLM: GDN7WCUBAKLLUYENLUBM6LA647UAS5QTZDNV3QZMMMQLOJJKPJKACJ3H

## License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.