thevickypedia / crypto-monitor

Python script to monitor crypto currencies

Cryptocurrency Monitor

Python scripts to monitor cryptocurrencies.

• yfinance - Get currency information using yahoo finance API
• requests - Get all cryptocurrencies from yahoo finance
• BeautifulSoup - Extract tag values from html response
• SMTP - Send SMS notification using Simple Mail Transfer Protocol

Requirements

pip install --no-cache --upgrade -r requirements.txt

Docker

docker build -t crypto .
docker run crypto

Note: DO NOT use alpine for docker as the build dependencies from simple/pandas fail due to missing pre-req.

Alternative is to use slim or install the modules directly from alpine repository

Coding Standards

Docstring format: Google
Styling conventions: PEP 8
Clean code with pre-commit hooks: flake8 and isort

Linting

PreCommit will ensure linting, and the doc creation are run on every commit.

Requirement
pip install --no-cache --upgrade sphinx pre-commit recommonmark

Usage
pre-commit run --all-files

Runbook:

https://thevickypedia.github.io/crypto-monitor/