CarsonWV/macro-indicator-dashboard

MacroDash is a GitHub Pages website that displays live-feeds and descriptions of varying macroeconomic indicators.

Summary

MacroDash is a GitHub Pages site that hosts descriptions and live-feeds of arbitrary macroeconomic indicators. This particular iteration displays the following:

• USA Real Gross Domestic Product
• USA Consumer Price Index for All Urban Consumers
• USA 10-Year Break-Even Inflation Rate

Website built using pure HTML, CSS. Indicators are updated daily by a Python script running on a Raspberry Pi 3B.

Install

• Clone this repository.
• Enable Github Pages from Settings.
• Install python dependencies, preferably to a virtual environment:
  • fredapi
  • chart-studio

$ pip install -r requirements.txt

Setup

Configure config.ini to include:

• API Keys for
  • FRED
  • plotly
• Absolute paths for:
  • Python interpreter OR virtual environment 'activate' file.
  • stats_updater.py (located in scripts folder).

dos2unix might be necessary to configure config.ini and script.sh for unix.

Usage

• Scheduling performed on unix by Cron.
• To schedule, create a Cron entry for 'script.sh' once config.ini has been set up. All errors logged with dates and times to error_log.txt for easy management.