This app was created as part of a collection of time-limited code challenges, usually used as a way to explore different tech. It provides weekly updates on the performance of a share price chosen by the user. Note the cron is currently disabled, but the workflow is still available to be run manually.
| Version | Update | Feature | Completed |
|---|---|---|---|
| v0.1.0 | Mid-week price snapshot | ✅ | |
| v0.2.0 | %/£ change in last week | ✅ | |
| v0.3.0 | %/£ change in last 28 days | ✅ | |
| v0.4.0 | %/£ change in last 6 month | ✅ | |
| v0.5.0 | %/£ change in last year | ✅ | |
| v0.6.0 | Email, Slack | implement slack notification | ✅ |
| v0.7.0 | Email, Slack | User can choose stock | ✅ |
| v0.8.0 | Email, Slack | a nice graph |
| Dependency | Version |
|---|---|
| Python | 3.11.3 |
| Poetry | 1.5.1 |
Clone the repo, ensure that you have a .env file with the below variables, or run it in github with the below set as secrets. You will need an eodhd.com api key, and a sendgrid api key. If you want to use the slack implementation you will need to set up a slack channel and bot separately.
Required variables:
EOD_API_KEY='< an eodhd api key >'
EOD_API_STOCK='< an eodhd api stock code >'
FROM_EMAIL='< a valid sendgrid account email >'
TO_EMAILS='< a comma+space separated list of emails, or a single email >'
SENDGRID_API_KEY='< a valid sendgrid api key >'
Optional variables:
WEBHOOK_URL='< a slack webhook url to send a table of stock data to a slack bot >'
make runFor this repo we follow a user-generated e2e testing strategy. This involves releasing the software to users, at which point they perform e2e tests on the software for free! If they stop using the software, we know it needs to improve. Some of them might even tell us which specific bits are broken.