https://github.com/thevickypedia/mortgage-rate-alert
A simple python script to run on a cron schedule to monitor mortgage rates and alert based on threshold
https://github.com/thevickypedia/mortgage-rate-alert
Last synced: 13 days ago
JSON representation
A simple python script to run on a cron schedule to monitor mortgage rates and alert based on threshold
- Host: GitHub
- URL: https://github.com/thevickypedia/mortgage-rate-alert
- Owner: thevickypedia
- License: mit
- Created: 2022-12-24T15:24:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-15T12:38:34.000Z (almost 2 years ago)
- Last Synced: 2025-02-12T22:22:47.013Z (9 months ago)
- Language: Python
- Size: 16.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mortgage Rate Monitor
A simple python script to monitor mortgage rates and alert based on threshold
## Env Variables
- **GMAIL_USER**: Gmail account username or email address.
- **GMAIL_PASS**: Gmail account password for authentication.
- **RECIPIENT**: Email address of the recipient.
*Any one of the following is required*
- **MIN_THRESHOLD**: Threshold below when a notification has to be triggered.
- **MAX_THRESHOLD**: Threshold above when a notification has to be triggered.
### Optional:
*Refer [nerdwallet](https://www.nerdwallet.com/mortgages/mortgage-rates) for options*
- **PRODUCT**: Defaults to `30-year fixed-rate`
- **TYPE_OF_RATE**: Defaults to `Interest rate`
### To run in a container
```shell
docker build -t mortgage .
docker run mortgage
```
### Sample cron schedule
```shell
0 8 * * * /usr/local/bin/docker run mortgage
```
> :warning: Scheduling it to run more than once a day is redundant and unnecessary, since results typically update daily
## License & copyright
© Vignesh Rao
Licensed under the [MIT License](https://github.com/thevickypedia/mortgage-rate-alert/blob/main/LICENSE)