Features

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

Features

• Metric cards — KPI widgets with values, change indicators, and icons
• SVG charts — Bar, line, and pie/donut charts rendered as inline SVG (no Chart.js needed)
• Data tables — Sortable columns with currency/percent/date formatting
• CSV/JSON export — One-click data export from any table
• Filters — Select dropdowns, date ranges, and search inputs
• Dark theme — Professional dark UI with configurable brand color
• Self-contained — Single HTML file output, works offline
• JSON config — Define dashboards as JSON, generate HTML

Requirements

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

Quick Start

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

Quick Start

# Generate a demo SaaS metrics dashboard
python src/main.py --demo

# Generate from a JSON config
python src/main.py --json examples/config.json

# Specify output directory
python src/main.py --demo --output ./my-dashboards

Then open the generated HTML file in your browser.

Programmatic Usage

from main import DashboardConfig, MetricCard, ChartData, DataTable, DashboardGenerator

config = DashboardConfig(
    title="My Dashboard",
    metrics=[
        MetricCard(title="Revenue", value="$12,345", change=8.5, icon="$"),
    ],
    charts=[
        ChartData(
            title="Monthly Revenue",
            chart_type="bar",
            labels=["Jan", "Feb", "Mar"],
            datasets=[{"label": "MRR", "values": [10000, 11500, 12345], "color": "#4F46E5"}],
        ),
    ],
)

generator = DashboardGenerator(config)
path = generator.save()