Metadata-Version: 2.4
Name: vizagent-dashboard
Version: 0.1.1
Summary: Compile CSV/XLSX data and DashboardSpec into validated offline HTML dashboards.
Project-URL: Homepage, https://github.com/Carloslee96/vizagent-dashboard
Project-URL: Source, https://github.com/Carloslee96/vizagent-dashboard
Author: VizAgent Team
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor has
              been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
License-File: NOTICE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.10
Requires-Dist: click>=8.0.0
Requires-Dist: openpyxl>=3.1.0
Requires-Dist: pydantic>=2.0.0
Provides-Extra: all
Requires-Dist: playwright>=1.45.0; extra == 'all'
Provides-Extra: browser
Requires-Dist: playwright>=1.45.0; extra == 'browser'
Provides-Extra: dev
Requires-Dist: build>=1.2.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Description-Content-Type: text/markdown

<div align="center">

# ⭐ vizagent-dashboard

**Turn business requirements into HTML dashboards — Use your own AI**

[![CI](https://github.com/Carloslee96/vizagent-dashboard/actions/workflows/ci.yml/badge.svg)](https://github.com/Carloslee96/vizagent-dashboard/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![PyPI](https://img.shields.io/pypi/v/vizagent-dashboard)](https://pypi.org/project/vizagent-dashboard/)
![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)

**You bring your data + your AI subscription. We compile them into a single HTML dashboard.**

</div>

<br>

<div align="center">
  <a href="examples/ecommerce/">
    <img src="docs/assets/ecommerce-thumb.png"
         alt="vizagent-dashboard demo — ecommerce dashboard in midnight-ops theme"
         width="720">
  </a>
  <br>
  <sub><i>pip install → one command → interactive HTML dashboard. No database, no server, no hidden API bills.</i></sub>
</div>

<br>

```bash
pip install vizagent-dashboard
vizagent build --data sales.xlsx --requirement "每月销售额趋势" --output dashboard/
# ✓ Dashboard generated in 3.2s → dashboard/output.html
# Open in browser — done.
```

---

## ✨ Features

- **🧠 AI-Powered, Your AI** — In Agent Skill mode the host AI (Claude, Codex, …) authors the `DashboardSpec` using reasoning you already pay for — no extra API key, no hidden bills.
- **🔧 Zero-API Spec Mode** — Prefer no AI at all? Write a structured `DashboardSpec` JSON and compile deterministically — zero LLM calls, zero API cost, works fully offline. The `--requirement` flag steers a built-in deterministic planner (still no LLM).
- **📦 Single HTML Output** — One self-contained file. No server, no database, no build step. Drop it on any static host or open directly in a browser.
- **📊 Rich Charts** — Line, bar, pie, scatter, map (China/world), KPI cards — powered by ECharts, inlined for offline use.
- **🎨 5 Clean-Room Themes** — `midnight-ops`, `paper-light`, `warm-editorial`, `clinical-light`, `signal-dark`. No third-party brand names or assets. Switch with `--theme <name>`.
- **📁 CSV & Excel** — Read from `.csv` or `.xlsx`, multiple sheets supported with per-sheet data-coverage tracking.
- **✅ Built-in Validation** — Static + optional Playwright checks for truncation, external-script dependency, empty series, unbound maps, and row-level data coverage.
- **🔒 Secure by Default** — Content Security Policy, HTML escaping, path traversal protection.
- **🤖 Agent Skill Ready** — Loadable as a Claude Code / Codex skill under `skills/build-data-dashboard/`.

---

## 🔑 API Key Model (Clear & Simple)

| Mode | Who pays for AI? | API Key needed? |
|------|-----------------|-----------------|
| **Agent Skill** (Claude/Codex) | **You** — already paying for your AI subscription | The skill uses your host AI's reasoning — no separate key to configure |
| **CLI — Spec mode** (`--spec`) | **Nobody** — compiler is fully deterministic | ❌ No API key needed |
| **CLI — Planner mode** (`--requirement`) | **Nobody** — a built-in deterministic planner steers the Spec from keywords | ❌ No API key needed |

> There is no `config` command and no `--planner` flag. The compiler and planner never call an LLM. All AI reasoning happens in your host agent (Agent Skill mode) — charged to your own subscription, never to this project.

---

## 🖼️ Gallery — one data file, five looks

同一份电商数据，5 个 clean-room 主题各编译一次。下图为其中 4 个主题的实际渲染首屏（截图来自 `examples/ecommerce/`）：

<div align="center">
  <table>
    <tr>
      <td align="center" width="50%">
        <a href="examples/ecommerce/">
          <img src="docs/assets/ecommerce-thumb.png" width="100%">
          <br><b>midnight-ops</b>（默认）
        </a>
        <br>深靛灰背景、蓝绿数据色
      </td>
      <td align="center" width="50%">
        <a href="examples/ecommerce/">
          <img src="docs/assets/theme-paper-light.png" width="100%">
          <br><b>paper-light</b>
        </a>
        <br>暖白纸张、墨色文字
      </td>
    </tr>
    <tr>
      <td align="center" width="50%">
        <a href="examples/ecommerce/">
          <img src="docs/assets/theme-warm-editorial.png" width="100%">
          <br><b>warm-editorial</b>
        </a>
        <br>浅米色、暗红重点
      </td>
      <td align="center" width="50%">
        <a href="examples/ecommerce/">
          <img src="docs/assets/theme-signal-dark.png" width="100%">
          <br><b>signal-dark</b>
        </a>
        <br>炭黑、琥珀青信号
      </td>
    </tr>
  </table>
</div>

> 第五个主题 `clinical-light` 可用 `--theme clinical-light` 自行构建查看。

---

## 🎨 5 Clean-Room Themes

One data file, five looks — each a generic, brand-free token set. Pick a theme that matches your story:

| Theme | Vibe | Best for |
|-------|------|----------|
| `midnight-ops` (default) | 深靛灰背景、蓝绿数据色 | 运营监控、技术演示 |
| `paper-light` | 暖白纸张、墨色文字 | 经营汇报、长时间阅读 |
| `warm-editorial` | 浅米色、暗红重点 | 内容分析、趋势故事 |
| `clinical-light` | 冷白、蓝青强调 | 健康、设备、服务质量 |
| `signal-dark` | 炭黑、琥珀青信号 | 告警、基础设施、高优先级状态 |

Legacy IDs (`monitor-dark`, `paper-brief`, `paper-linen`, `minimal-doc`, `clean-slate`, `fitness-glass`, `command-post`, `amber-console`) resolve to the closest theme above.

Switch with `--theme <name>`:

```bash
vizagent build --data sales.xlsx --theme paper-light --output dashboard/
```

---

## 🚀 Quick Start

### 1. Install

```bash
pip install vizagent-dashboard
```

### 2. Prepare your data

Save your data as CSV or Excel:

```bash
# sales.xlsx
# ┌──────────┬──────────┬──────────┬──────────┐
# │ 月份     │ 销售额   │ 类别     │ 地区     │
# ├──────────┼──────────┼──────────┼──────────┤
# │ 2026-01  │ 128000   │ 数码     │ 华东     │
# │ 2026-02  │ 135000   │ 数码     │ 华东     │
# │ ...      │ ...      │ ...      │ ...      │
# └──────────┴──────────┴──────────┴──────────┘
```

### 3. Build your dashboard

```bash
vizagent build \
  --data sales.xlsx \
  --requirement "月度销售额趋势，按类别和地区拆分，包含关键指标" \
  --output my-dashboard/
```

### 4. Open `my-dashboard/output.html` in your browser

---

## 📖 Usage

```bash
# Spec mode: data file + structured spec → zero API cost
vizagent build --data data.xlsx --spec spec.json --output dashboard/

# Planner mode: data file + requirement keywords → deterministic Spec (still no LLM)
vizagent build --data data.xlsx --requirement "按省份的销售额地图" --output dashboard/

# Specify theme
vizagent build --data data.xlsx --theme midnight-ops --output dashboard/

# Full pipeline
vizagent build \
  --data data.xlsx \
  --requirement "展示各品类季度趋势，顶部 KPI 卡片显示总额和增长" \
  --theme paper-light \
  --output dashboard/
```

### Options

| Option | Default | Description |
|--------|---------|-------------|
| `--data` | required | Path to CSV or Excel file |
| `--requirement` | `""` | Business requirement; steers the deterministic planner (no LLM) |
| `--spec` | — | Path to DashboardSpec JSON (zero-API mode) |
| `--theme` | from Spec or `midnight-ops` | Theme override; see [Themes](#-5-clean-room-themes) |
| `--page-mode` | `single_page` | `single_page` or `tabs` |
| `--deployment` | `embedded` | `embedded` (offline) or `cdn` |
| `--output` | `./output` | Output directory |
| `--browser` | `false` | Run the Playwright validation gate |
| `--open` | `false` | Open dashboard in browser after build |

---

## 🏗️ Architecture

```
┌──────────────┐    ┌────────────┐    ┌──────────────┐
│  CSV / XLSX  │───▶│  Inventory │───▶│   Compiler   │───▶ output.html
│  (your data) │    │  (analyze) │    │  (generate)  │
└──────────────┘    └────────────┘    └──────────────┘
                          │                  │
                          ▼                  ▼
                   ┌──────────────┐   ┌──────────────┐
                   │ Requirement  │   │  Validator   │
                   │ (NLP → spec) │   │  (quality)   │
                   └──────────────┘   └──────────────┘
```

**Key design**: The Compiler is fully deterministic — no LLM, no API call, no network. The Planner (requirement → Spec) is a deterministic keyword planner, not an LLM. In Agent Skill mode the host AI authors the `DashboardSpec` using its own reasoning. In spec mode, the entire pipeline works offline with zero API cost.

---

## 🤖 Agent Skill Mode

vizagent-dashboard ships as a loadable **Claude Code / Codex** skill at `skills/build-data-dashboard/` (with `SKILL.md` + `agents/openai.yaml`). The host AI reads the inventory, authors a `DashboardSpec`, then runs the `vizagent` CLI to compile and validate:

```bash
vizagent inventory --data <file> --output data.inventory.json
vizagent compile  --data <file> --spec <spec.json> --output dashboard/
vizagent validate --data <file> --spec <spec.json> --html dashboard/output.html
```

The skill uses **your host AI's own reasoning** — you're already paying for your AI subscription, no extra key to configure.

---

## 🧪 Development

```bash
# Clone
git clone https://github.com/Carloslee96/vizagent-dashboard.git
cd vizagent-dashboard

# Install in editable mode
pip install -e ".[dev]"

# Run tests
python -m pytest tests/ -v

# Lint
pip install ruff
ruff check src/ tests/
```

---

## 📄 License

Apache 2.0 © VizAgent Team. See [LICENSE](LICENSE).

---

## 🌟 Star History

[![Star History Chart](https://api.star-history.com/svg?repos=Carloslee96/vizagent-dashboard&type=Date)](https://star-history.com/#Carloslee96/vizagent-dashboard&Date)

---

<div align="center">
  <b>No database. No server. Just one HTML file.<br>
  You bring your data and your AI subscription — we do the rest.</b>
  <br><br>
  <a href="https://github.com/Carloslee96/vizagent-dashboard/stargazers">
    <img src="https://img.shields.io/github/stars/Carloslee96/vizagent-dashboard?style=social" alt="stars">
  </a>
</div>
