https://github.com/thevickypedia/skynet
Stock Alerter using Robinhood API
https://github.com/thevickypedia/skynet
robinhood-api stock-alerter stock-market
Last synced: 4 months ago
JSON representation
Stock Alerter using Robinhood API
- Host: GitHub
- URL: https://github.com/thevickypedia/skynet
- Owner: thevickypedia
- License: mit
- Created: 2020-08-20T00:10:54.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-27T15:15:56.000Z (almost 3 years ago)
- Last Synced: 2025-07-08T14:09:11.138Z (4 months ago)
- Topics: robinhood-api, stock-alerter, stock-market
- Language: Python
- Homepage: https://thevickypedia.github.io/skynet/
- Size: 266 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Skynet
Stock Alerter using `Robinhood`/`YFinance` api
The stock ticker value, minimum amount below and maximum amount above which you'd like to be notified has to be added to a file: `stocks.json`.
Below is an example for a single stock, this can be extended as needed.
### Source File
> Minimum and maximum values for the stock can be either a list or a comma separated string.
> The order doesn't matter.
```json
{
"AMZN": [4000, 3000],
"TSLA": "1000, 1400"
}
```
### Env Variables
This script is designed to run locally using env vars stored in a `.env` file which is loaded upon startup.
Store env vars as below (either in `.env` file or as regular env vars)
For stock analyzing:
- `robinhood_user = xxx@yyy.com`
- `robinhood_pass = `
- `robinhood_qr = `
> :bulb: Skynet can work even without `Robinhood` access, as it automatically chooses `YahooFinance` to gather the details.
> However using `YahooFinance` runs longer due to endpoint restrictions.
For notifications:
- `gmail_user = xxx@gmail.com`
- `gmail_pass = PASSWORD`
- `phone = +1234567890`
> :bulb: Phone numbers can be `comma` separated values, to notify multiple people.
> If notifications via [`gmail-connector`](https://github.com/thevickypedia/gmail-connector) fails, an SMS is triggered using AWS SNS.
### 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://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
[https://thevickypedia.github.io/gmail-connector/](https://thevickypedia.github.io/gmail-connector/)
## License & copyright
© Vignesh Sivanandha Rao, Skynet
Licensed under the [MIT License](https://github.com/thevickypedia/skynet/blob/master/LICENSE)