s2t2 / Unemployment-Report

Setup

Create and activate a virtual environment:

conda create -n unemployment-env python=3.8

conda activate unemployment-env

Install package dependencies:

pip install -r requirements.txt

Configuration

Obtain an API Key from AlphaVantage.

Then create a local ".env" file and provide the key like this:

# this is the ".env" file...

ALPHAVANTAGE_API_KEY="_________"

Usage

Run an example script:

python app/my_script.py

Run the unemployment report:

python -m app.unemployment
# or pass env var from command line:
ALPHAVANTAGE_API_KEY="______" python app/unemployment.py

Run the stocks report:

python -m app.stocks

Testing

Run Tests:

pytest