create-hedgeboard 1.0.7 → 1.0.8

package/hedgeboard/modules/company_overview.py

@@ -1,157 +0,0 @@
-"""Company overview module.
-
-Generates a comprehensive company profile given a ticker symbol:
-- Company info (name, sector, exchange)
-- Latest filings
-- Key financial metrics (revenue, net income, EPS, assets)
-- Revenue trend chart
-- Financial summary table
-
-Usage:
-    from modules.company_overview import company_overview
-    company_overview("TWLO")
-"""
-
-from __future__ import annotations
-
-from data.sec import HedgeBoardClient
-from viz.charts import line_chart, bar_chart
-from viz.tables import financial_table
-from viz.dashboard import render_dashboard
-
-
-def company_overview(ticker: str, serve: bool = True) -> None:
-    """Generate a company overview dashboard.
-
-    Args:
-        ticker: Company ticker symbol (e.g., "TWLO", "AAPL").
-        serve: If True, open dashboard in browser.
-    """
-    hb = HedgeBoardClient()
-    ticker = ticker.upper()
-
-    # 1. Company info
-    company = hb.get_company(ticker)
-    if not company:
-        print(f"❌ Company not found: {ticker}")
-        return
-
-    name = company.get("name", ticker)
-    exchange = company.get("exchange", "")
-    sic_desc = company.get("sic_description", "")
-
-    # 2. Latest filings
-    annual_filings = hb.get_filings(ticker, form_type="10-K", limit=5)
-    quarterly_filings = hb.get_filings(ticker, form_type="10-Q", limit=4)
-
-    # 3. Key financials
-    financials = hb.get_key_financials(ticker, form_type="10-K", periods=5)
-
-    # Build sections
-    sections = []
-
-    # --- Company Header ---
-    info_section = f"""## {name} ({ticker})
-**Exchange:** {exchange} · **Sector:** {sic_desc}
-**CIK:** {company.get('cik', 'N/A')}
-"""
-    sections.append(info_section)
-
-    # --- Revenue Chart ---
-    revenue_key = None
-    for key in ["Revenues", "RevenueFromContractWithCustomerExcludingAssessedTax"]:
-        if key in financials:
-            revenue_key = key
-            break
-
-    if revenue_key:
-        rev_data = sorted(financials[revenue_key], key=lambda x: x.get("period_end", ""))
-        labels = [f.get("period_end", "")[:4] for f in rev_data]
-        values = [float(f.get("value", 0)) / 1_000_000 for f in rev_data]
-
-        sections.append(
-            line_chart(
-                labels=labels,
-                datasets=[{"label": "Revenue ($M)", "data": values}],
-                title=f"{ticker} Annual Revenue",
-            )
-        )
-
-    # --- Financial Summary Table ---
-    table_rows = []
-    concept_labels = {
-        "Revenues": "Revenue",
-        "RevenueFromContractWithCustomerExcludingAssessedTax": "Revenue",
-        "NetIncomeLoss": "Net Income",
-        "EarningsPerShareDiluted": "EPS (Diluted)",
-        "Assets": "Total Assets",
-        "Liabilities": "Total Liabilities",
-        "StockholdersEquity": "Stockholders' Equity",
-        "OperatingIncomeLoss": "Operating Income",
-        "CashAndCashEquivalentsAtCarryingValue": "Cash & Equivalents",
-    }
-
-    # Collect periods
-    all_periods = set()
-    for facts in financials.values():
-        for f in facts:
-            all_periods.add(f.get("period_end", "")[:4])
-    periods = sorted(all_periods)[-5:]  # Last 5 years
-
-    if periods:
-        headers = ["Metric"] + periods
-        for concept, label in concept_labels.items():
-            if concept not in financials:
-                continue
-            row = [label]
-            facts_by_period = {
-                f.get("period_end", "")[:4]: f for f in financials[concept]
-            }
-            for period in periods:
-                fact = facts_by_period.get(period)
-                if fact:
-                    val = float(fact.get("value", 0))
-                    if concept == "EarningsPerShareDiluted":
-                        row.append(f"${val:.2f}")
-                    else:
-                        row.append(val)
-                else:
-                    row.append(None)
-            table_rows.append(row)
-
-        if table_rows:
-            sections.append(
-                financial_table(
-                    headers=headers,
-                    rows=table_rows,
-                    title="Key Financial Metrics (Annual)",
-                )
-            )
-
-    # --- Filings List ---
-    filing_lines = []
-    for f in (annual_filings or [])[:5]:
-        filing_lines.append(
-            f"- **{f.get('form_type', '')}** — {f.get('filing_date', 'N/A')}"
-        )
-    for f in (quarterly_filings or [])[:4]:
-        filing_lines.append(
-            f"- **{f.get('form_type', '')}** — {f.get('filing_date', 'N/A')}"
-        )
-
-    if filing_lines:
-        sections.append("### Recent Filings\n" + "\n".join(filing_lines))
-
-    # --- Source Citation ---
-    sections.append(
-        f"*Source: SEC EDGAR via HedgeBoard API. "
-        f"Data as of latest available filing.*"
-    )
-
-    # Render
-    render_dashboard(
-        title=f"{name} — Company Overview",
-        sections=sections,
-        output_name=f"{ticker.lower()}_overview",
-        serve=serve,
-    )

package/hedgeboard/requirements.txt

@@ -1,2 +0,0 @@
-requests>=2.31
-python-dotenv>=1.0

package/hedgeboard/viz/__init__.py

@@ -1 +0,0 @@
-"""HedgeBoard visualization components."""

package/hedgeboard/viz/charts.py

@@ -1,198 +0,0 @@
-"""Chart generation using Chart.js.
-
-Generates self-contained HTML snippets with embedded Chart.js charts
-that use the HedgeBoard color palette for distinct multi-series contrast.
-
-Usage:
-    from viz.charts import line_chart, bar_chart
-
-    html = line_chart(
-        labels=["Q1", "Q2", "Q3", "Q4"],
-        datasets=[{"label": "Revenue ($M)", "data": [980, 1020, 1060, 1090]}],
-        title="Quarterly Revenue"
-    )
-"""
-
-from __future__ import annotations
-
-import json
-import uuid
-from pathlib import Path
-
-_THEME_PATH = Path(__file__).resolve().parent.parent / "brand" / "theme.json"
-
-# 8 distinct chart colors — high contrast on dark backgrounds
-CHART_COLORS = [
-    "#EAEAEA",   # primary white
-    "#4ADE80",   # green
-    "#60A5FA",   # blue
-    "#FBBF24",   # amber
-    "#F87171",   # red
-    "#A78BFA",   # purple
-    "#34D399",   # teal
-    "#FB923C",   # orange
-]
-
-CHART_COLORS_DIM = [
-    "rgba(234,234,234,0.15)",
-    "rgba(74,222,128,0.15)",
-    "rgba(96,165,250,0.15)",
-    "rgba(251,191,36,0.15)",
-    "rgba(248,113,113,0.15)",
-    "rgba(167,139,250,0.15)",
-    "rgba(52,211,153,0.15)",
-    "rgba(251,146,60,0.15)",
-]
-
-
-def _load_theme() -> dict:
-    """Load the brand theme, falling back to HedgeBoard defaults."""
-    try:
-        with open(_THEME_PATH) as f:
-            return json.load(f)
-    except (FileNotFoundError, json.JSONDecodeError):
-        return {
-            "colors": {
-                "primary": "#EAEAEA",
-                "accent": "#CACACA",
-                "background": "#0C0C10",
-                "surface": "#151519",
-                "text": "#EAEAEA",
-                "muted": "#6B6B78",
-                "border": "#2A2A33",
-            }
-        }
-
-
-def line_chart(
-    labels: list[str],
-    datasets: list[dict],
-    title: str = "",
-    height: int = 320,
-) -> str:
-    """Generate a branded line chart.
-
-    Args:
-        labels: X-axis labels.
-        datasets: List of dicts, each with "label" and "data" keys.
-        title: Chart title.
-        height: Chart height in pixels.
-
-    Returns:
-        HTML string with an embedded Chart.js line chart.
-    """
-    return _render_chart("line", labels, datasets, title, height)
-
-
-def bar_chart(
-    labels: list[str],
-    datasets: list[dict],
-    title: str = "",
-    height: int = 320,
-) -> str:
-    """Generate a branded bar chart.
-
-    Args:
-        labels: X-axis labels.
-        datasets: List of dicts, each with "label" and "data" keys.
-        title: Chart title.
-        height: Chart height in pixels.
-
-    Returns:
-        HTML string with an embedded Chart.js bar chart.
-    """
-    return _render_chart("bar", labels, datasets, title, height)
-
-
-def _render_chart(
-    chart_type: str,
-    labels: list[str],
-    datasets: list[dict],
-    title: str,
-    height: int,
-) -> str:
-    """Render a Chart.js chart as an HTML snippet."""
-    theme = _load_theme()
-    colors = theme.get("colors", {})
-    canvas_id = f"chart-{uuid.uuid4().hex[:8]}"
-
-    # Build Chart.js dataset configs — each series gets a distinct color
-    chart_datasets = []
-    for i, ds in enumerate(datasets):
-        color = CHART_COLORS[i % len(CHART_COLORS)]
-        fill_color = CHART_COLORS_DIM[i % len(CHART_COLORS_DIM)]
-        chart_datasets.append({
-            "label": ds.get("label", f"Series {i + 1}"),
-            "data": ds.get("data", []),
-            "borderColor": color,
-            "backgroundColor": fill_color if chart_type == "line" else color,
-            "borderWidth": 2,
-            "tension": 0.3,
-            "pointRadius": 3,
-            "pointBackgroundColor": color,
-            "fill": chart_type == "line",
-            "barPercentage": 0.7,
-            "categoryPercentage": 0.8,
-        })
-
-    config = {
-        "type": chart_type,
-        "data": {"labels": labels, "datasets": chart_datasets},
-        "options": {
-            "responsive": True,
-            "maintainAspectRatio": False,
-            "plugins": {
-                "title": {
-                    "display": bool(title),
-                    "text": title,
-                    "color": colors.get("text", "#EAEAEA"),
-                    "font": {"size": 14, "weight": "600", "family": "'Space Grotesk', sans-serif"},
-                    "padding": {"bottom": 16},
-                },
-                "legend": {
-                    "position": "bottom",
-                    "labels": {
-                        "color": colors.get("muted", "#6B6B78"),
-                        "font": {"size": 11, "family": "'IBM Plex Mono', monospace"},
-                        "boxWidth": 12,
-                        "boxHeight": 2,
-                        "padding": 16,
-                    },
-                },
-                "tooltip": {
-                    "backgroundColor": colors.get("surface", "#151519"),
-                    "titleFont": {"family": "'Space Grotesk', sans-serif"},
-                    "bodyFont": {"family": "'IBM Plex Mono', monospace", "size": 12},
-                    "borderColor": colors.get("border", "#2A2A33"),
-                    "borderWidth": 1,
-                    "padding": 12,
-                    "cornerRadius": 2,
-                },
-            },
-            "scales": {
-                "x": {
-                    "ticks": {
-                        "color": colors.get("muted", "#6B6B78"),
-                        "font": {"size": 11, "family": "'IBM Plex Mono', monospace"},
-                    },
-                    "grid": {"color": colors.get("border", "#2A2A33"), "lineWidth": 0.5},
-                    "border": {"color": colors.get("border", "#2A2A33")},
-                },
-                "y": {
-                    "ticks": {
-                        "color": colors.get("muted", "#6B6B78"),
-                        "font": {"size": 11, "family": "'IBM Plex Mono', monospace"},
-                    },
-                    "grid": {"color": colors.get("border", "#2A2A33"), "lineWidth": 0.5},
-                    "border": {"display": False},
-                },
-            },
-        },
-    }
-
-    return f"""<div style="position:relative;height:{height}px;width:100%;background:{colors.get('surface', '#151519')};border:1px solid {colors.get('border', '#2A2A33')};border-radius:2px;padding:20px;box-sizing:border-box;">
-  <canvas id="{canvas_id}"></canvas>
-</div>
-<script>
-new Chart(document.getElementById('{canvas_id}'), {json.dumps(config)});
-</script>"""