Skip to main content

Gere dashboards visuais como imagens usando HTML/CSS e Playwright.

Project description

Dashgen

📊 Gere dashboards visuais como imagens (PNG) diretamente do Python com HTML, CSS e Chart.js.


✨ O que é?

dashgen é um micro-framework que permite criar dashboards dinâmicos e exportá-los como imagens de alta qualidade.

Ideal para gerar relatórios diários, KPIs, resumos visuais e compartilhar automaticamente via e-mail, WhatsApp, etc.


🛠 Instalação

pip install dashgen
playwright install

🚀 Exemplo Completo

from dashgen import Dashboard
from dashgen.core.layout import Row, Column

# Criar o dashboard
db = Dashboard(
    title="Relatório de Vendas",
    logo_path="logo.png",  # Caminho da logo opcional
    size=(1080, 1080),
    theme={
        "primary": "#005f73",  # Cor de destaque
        "accent": "#94d2bd",   # Cor auxiliar
        "bg": "#fefae0",       # Fundo
        "text": "#001219"      # Texto padrão
    }
)

# Linha com dois cards lado a lado
db.add(Row(
    Column(6).add_card("Receita Acumulada", 8200000, 10000000),
    Column(6).add_card("Unidades Vendidas", 320, 400)
))

# Linha com tabela e gráfico de barras
dados = [
    {"Nome": "Projeto A", "Meta": "R$ 2M", "Realizado": "R$ 1.6M", "Variação": "-20%"},
    {"Nome": "Projeto B", "Meta": "R$ 3M", "Realizado": "R$ 3.1M", "Variação": "+3%"},
]
db.add(Row(
    Column(6).add_table("Receita por Empreendimento", dados, ["Nome", "Meta", "Realizado", "Variação"]),
    Column(6).add_chart("bar", "Vendas Mensais", [
        {"label": "Jan", "value": 120},
        {"label": "Fev", "value": 135},
        {"label": "Mar", "value": 160},
    ])
))

# Gráfico de linha ocupando a largura total
db.add(Row(
    Column(12).add_chart("line", "Receita Total (R$)", [
        {"label": "Jan", "value": 1200000},
        {"label": "Fev", "value": 1450000},
        {"label": "Mar", "value": 1600000},
    ])
))

# Exportar como imagem
db.generate("output_dashboard.png")

🧱 Componentes Disponíveis

🧩 Layout

  • Row(...): Agrupa colunas horizontalmente.
  • Column(width=...): Define largura (1 a 12 colunas).

📦 Cards

Column(6).add_card("Título", valor, meta)

KPI com barra de progresso proporcional a valor/meta.


📊 Tabela

Column(6).add_table("Título", data, headers)
  • data: lista de dicionários
  • headers: chaves a exibir

📈 Gráfico

Column(6).add_chart("bar", "Título", data)
Column(6).add_chart("line", "Título", data)
  • data: lista de { "label": ..., "value": ... }
  • chart_type: "bar" ou "line"

🎨 Tema Personalizado

theme = {
    "primary": "#005f73",  # Cor de destaque (barras, títulos)
    "accent": "#94d2bd",   # Cor auxiliar
    "bg": "#fefae0",       # Fundo da imagem
    "text": "#001219"      # Texto padrão
}

📚 Documentação Técnica

📘 Classe: Dashboard

Dashboard(
    title="Meu Relatório",
    logo_path=None,
    size=(1080, 1080),
    theme=None
)
Parâmetro Tipo Descrição
title str Título no topo da imagem
logo_path str (opcional) Caminho para logo
size (int, int) Tamanho da imagem
theme dict[str, str] Cores CSS (ver acima)

Dashboard.add(layout: Row)

Adiciona uma linha com colunas ao dashboard.


Dashboard.generate(path: str)

Gera e salva a imagem em path.


📘 Classe: Row

Row(Column(...), Column(...))

Agrupa colunas horizontalmente. Largura total deve somar até 12.


📘 Classe: Column(width=12)

Define a largura da coluna (1 a 12).


Column.add_card(title, value, target)

Exibe um indicador com barra de progresso.


Column.add_table(title, data, headers)

Cria uma tabela a partir de dados estruturados.


Column.add_chart(chart_type, title, data)

Cria gráfico do tipo "bar" ou "line" com dados de label e value.


✅ Requisitos

  • Python 3.7+
  • playwright (playwright install)
  • jinja2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dashgen-0.1.2.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dashgen-0.1.2-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file dashgen-0.1.2.tar.gz.

File metadata

  • Download URL: dashgen-0.1.2.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for dashgen-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2f743366681b610cf4147e08cda173fc7785d79a6034a97923ad1e61bf23d83b
MD5 d1edbf140f233c75d160c213dc00e68f
BLAKE2b-256 fbad6ef545a0a04cec18739f7b780fbeeafb5e7c2aa6dedbdf914179459e3578

See more details on using hashes here.

File details

Details for the file dashgen-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: dashgen-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for dashgen-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1177d66515b85fdcd46cfe4bf62558dd1aac13c6e84246d3738adba6fe4226b4
MD5 fe303d73d8a875b6c7cbb496c20b0660
BLAKE2b-256 a79a6b8a073410dde86927a30d296494b6b331edaef9bf878651c06d4b3cd199

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page