README.md

codebase-cleanup-template

To get started with the "Codebase Cleanup" Exercise.

Setup

Create virtual environment:

conda create -n cleanup-env python=3.8

conda activate cleanup-env

Install packages:

pip install -r requirements.txt

Configuration

Obtain a premium AlphaVantage API Key here.

Sign up for a SendGrid Account, verify single sender, then obtain a Sendgrid API Key.

Set environment variables using a ".env" file approach:

ALPHAVANTAGE_API_KEY="..."

SENDER_ADDRESS="example@gmail.com"
SENDGRID_API_KEY="SG...."

Usage

Run the game:

python -m app.game

Run crypto:

python -m app.crypto

Run stocks:

python -m app.stocks

Run unemployment:

python -m app.unemployment
python -m app.unemployment_email

Run groceries:

python -m app.groceries

Run email me:

python -m app.email_me

Testing

Type the following command into the command line interface:

pytest