Features

This chapter covers the core features and capabilities of KPI Dashboard.

Features

• Traffic-light status — Green/yellow/red indicators based on configurable thresholds
• Trend indicators — Period-over-period change with directional arrows
• Target progress bars — Visual progress toward goals
• Alert summary — Critical and warning KPIs highlighted at the top
• Category grouping — Organize metrics by category (revenue, engagement, growth)
• Auto-refresh — Set a refresh interval for live monitoring
• Dark theme — Professional dark UI with brand accent color
• Self-contained HTML — Single file output with embedded CSS

Requirements

• Python 3.10+
• No external dependencies (stdlib only)

Quick Start

Follow this guide to get KPI Dashboard up and running in your environment.

Quick Start

# Generate KPI dashboard from JSON
python src/kpi_dashboard.py --data examples/sample_kpis.json --output dashboard.html

# Custom title and auto-refresh every 30 seconds
python src/kpi_dashboard.py --data kpis.json --title "Acme Corp KPIs" --refresh 30

# Custom brand color
python src/kpi_dashboard.py --data kpis.csv --color "#FF3366" --output report.html

Input Format

JSON array of KPI objects:

[
    {
        "name": "MRR",
        "value": 68700,
        "unit": "$",
        "green_above": 60000,
        "yellow_above": 45000,
        "trend": 5.2,
        "target": 75000,
        "description": "Monthly Recurring Revenue",
        "category": "revenue"
    }
]

Field Reference

Status Logic

• Green: value >= green_above
• Yellow: value >= yellow_above but < green_above
• Red: value < yellow_above
• Neutral: no thresholds defined