https://github.com/thevickypedia/crypto-monitor
Python script to monitor crypto currencies
https://github.com/thevickypedia/crypto-monitor
beautifulsoup cryptocurrency smtp threadpool yfinance-api
Last synced: about 2 months ago
JSON representation
Python script to monitor crypto currencies
- Host: GitHub
- URL: https://github.com/thevickypedia/crypto-monitor
- Owner: thevickypedia
- Created: 2021-06-10T18:47:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-26T22:34:37.000Z (over 2 years ago)
- Last Synced: 2025-02-12T22:23:07.930Z (4 months ago)
- Topics: beautifulsoup, cryptocurrency, smtp, threadpool, yfinance-api
- Language: Python
- Homepage: https://thevickypedia.github.io/crypto-monitor/
- Size: 188 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cryptocurrency Monitor
Python scripts to monitor cryptocurrencies.
- `yfinance` - Get currency information using yahoo finance [API](https://pypi.org/project/yfinance/)
- `requests` - Get all cryptocurrencies from [yahoo finance](https://finance.yahoo.com/)
- `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`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/)
Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and
[`isort`](https://pycqa.github.io/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/