structviz 0.2__tar.gz

structviz-0.2/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: structviz
+Version: 0.2
+Summary: 声明式股权图与组织架构图生成工具 — YAML 驱动，D2/Graphviz/Excalidraw 三引擎
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: graphviz>=0.20
+Requires-Dist: click>=8.0
+Requires-Dist: jinja2>=3.0
+
+# StructViz
+
+声明式股权图与组织架构图生成工具。YAML 定义结构，一键输出 PNG / PDF / SVG / HTML / Excalidraw 图表。
+
+双引擎：**D2**（直角线 SVG） + **Graphviz DOT**（自动布局） + **Excalidraw**（精确定位）。
+
+## 安装
+
+```bash
+# D2 引擎
+sudo pacman -S d2              # Arch
+# 或从 https://github.com/terrastruct/d2/releases 下载
+
+# DOT 引擎
+sudo pacman -S graphviz        # Arch
+sudo apt install graphviz      # Debian
+
+# Python 包
+pip install structviz
+```
+
+## 快速开始
+
+```bash
+# D2 引擎（直角线 SVG）
+structviz examples/org_siku.yaml -t org -f d2 -o output/
+
+# DOT 引擎
+structviz examples/org_bingong.yaml -t org -f png,pdf -p a4 -o output/
+
+# Excalidraw 引擎
+structviz examples/org_bingong.yaml -t org -f excalidraw -o output/
+
+# 股权图
+structviz examples/equity_sample.yaml -t equity -f png -o output/
+```
+
+## CLI
+
+```
+structviz YAML_FILE [OPTIONS]
+
+Options:
+  -t, --type [equity|org]   图表类型 (必填)
+  -f, --formats TEXT        输出格式: png,pdf,svg,html,excalidraw,d2
+  -o, --output TEXT         输出目录
+  -p, --papersize TEXT      纸张: a4|a3|letter 或自定义 "W,H[mm|in]"
+  -d, --dpi INTEGER         输出 DPI
+```
+
+## YAML 结构
+
+### 组织架构图 (org)
+
+```yaml
+meta:
+  type: org
+  title: "组织架构"
+  theme: corporate
+  papersize: a4
+  dpi: 150
+  layout:                    # 全局布局参数
+    max_columns: 3           # 底族每行最多数
+    nodesep: 0.3             # 同行节点间距 (英寸)
+    ranksep: 0.6             # 行间距 (英寸)
+    block_pad: 0.15          # block 内边距
+    row_gap: 1               # 换行间距 (minlen)
+    # D2 专用
+    deputy_gap: 40           # 中心领导框内间距
+    wrap_width: 12           # 部门名自动换行宽度（0=不换）
+    dept_gap: 6              # 板块内部门间距
+    dept_width: 150          # 部门节点宽度
+
+groups:
+  - level: 0
+    label: "权力机构"
+    gap: 0.8                 # 到下层间距
+    nodes:
+      - id: 股东大会
+        title: "股东大会"
+        style: large         # large | default | external
+
+  - level: 1
+    label: "决策层"
+    blocks:
+      - id: 专业委员会
+        position: right      # right=同行右侧 | bottom=下一行 | left=同行左侧
+        max_columns: 3       # 块内每行节点数
+        block_align: left    # left | center
+        edge_from: 董事会    # 箭头到块边框
+        nodes:
+          - id: 战略委员会
+            title: "战略委员会"
+
+  - level: 2
+    gap: 1.5
+    nodesep: 3               # 本层节点间距 (覆盖全局)
+    nodes:
+      - id: 业务运营
+        title: "业务运营"
+        style: large
+        reports_to: 总经理   # 自动连线
+
+  - level: 3
+    blocks:
+      - id: 业务运营板块
+        position: bottom
+        max_columns: 2
+        edge_from: 业务运营
+        nodes:
+          - id: 债贷业务部
+            title: "债贷业务部"
+```
+
+### OrgNode 字段
+
+| 字段 | 说明 |
+|------|------|
+| `id` | 唯一标识 |
+| `title` | 显示标题，`\n` 换行 |
+| `name` | 副标题 (可选) |
+| `role` | 小字职务 (可选) |
+| `style` | `large`(居中加粗) / `default` / `external`(橙色) |
+| `reports_to` | 上级节点 id |
+| `is_cluster_head` | 板块标题 (仅 block 内) |
+
+### OrgGroup 布局参数
+
+| 字段 | 说明 |
+|------|------|
+| `gap` | 到下层垂直间距 |
+| `offset` | 水平偏移 (英寸) |
+| `nodesep` | 本层节点间距 (覆盖全局) |
+| `max_columns` | blocks 每行数 (覆盖全局) |
+| `max_right_columns` | right_nodes 每行数 |
+
+### OrgBlock 字段
+
+| 字段 | 说明 |
+|------|------|
+| `position` | `right` / `bottom` / `left` |
+| `max_columns` | 块内每行节点数 |
+| `row_gap` | 块内换行间距 (minlen) |
+| `block_align` | `left` / `center` |
+| `edge_from` | 箭头源节点 id |
+
+## 纸张尺寸
+
+| 预设 | 尺寸 |
+|------|------|
+| a4 | 210×297mm |
+| a3 | 297×420mm |
+| letter | 8.5×11in |
+| 自定义 | `"200,260"` (mm) 或 `"8.5,11in"` |
+
+## 输出文件
+
+| 引擎 | 格式 | 文件 |
+|------|------|------|
+| D2 | d2 | `name.d2` (源码) + `name_d2.svg` |
+| DOT | png, pdf, svg | `name.png`, `name.svg` |
+| DOT | html | `name.html` |
+| Excalidraw | excalidraw | `name.excalidraw` + `name_ex.png` |
+
+## 项目结构
+
+```
+structviz/
+├── pyproject.toml
+├── README.md
+├── examples/
+│   ├── equity_sample.yaml
+│   ├── org_siku.yaml
+│   └── org_bingong.yaml
+└── structviz/
+    ├── models.py               # Pydantic 模型
+    ├── themes.py               # 主题 + 纸张
+    ├── cli.py                  # CLI 入口
+    ├── render.py               # DOT 渲染
+    ├── d2_render.py            # D2 渲染 + 直角后处理
+    ├── html_wrapper.py         # HTML 包装
+    ├── excalidraw_render.py    # Excalidraw → PNG
+    └── generators/
+        ├── equity.py           # 股权图 DOT
+        ├── org.py              # 组织架构 DOT
+        ├── d2.py               # 组织架构 D2
+        └── excalidraw.py       # 组织架构 Excalidraw
+```
+
+## 许可
+
+MIT

structviz-0.2/README.md

@@ -0,0 +1,192 @@
+# StructViz
+
+声明式股权图与组织架构图生成工具。YAML 定义结构，一键输出 PNG / PDF / SVG / HTML / Excalidraw 图表。
+
+双引擎：**D2**（直角线 SVG） + **Graphviz DOT**（自动布局） + **Excalidraw**（精确定位）。
+
+## 安装
+
+```bash
+# D2 引擎
+sudo pacman -S d2              # Arch
+# 或从 https://github.com/terrastruct/d2/releases 下载
+
+# DOT 引擎
+sudo pacman -S graphviz        # Arch
+sudo apt install graphviz      # Debian
+
+# Python 包
+pip install structviz
+```
+
+## 快速开始
+
+```bash
+# D2 引擎（直角线 SVG）
+structviz examples/org_siku.yaml -t org -f d2 -o output/
+
+# DOT 引擎
+structviz examples/org_bingong.yaml -t org -f png,pdf -p a4 -o output/
+
+# Excalidraw 引擎
+structviz examples/org_bingong.yaml -t org -f excalidraw -o output/
+
+# 股权图
+structviz examples/equity_sample.yaml -t equity -f png -o output/
+```
+
+## CLI
+
+```
+structviz YAML_FILE [OPTIONS]
+
+Options:
+  -t, --type [equity|org]   图表类型 (必填)
+  -f, --formats TEXT        输出格式: png,pdf,svg,html,excalidraw,d2
+  -o, --output TEXT         输出目录
+  -p, --papersize TEXT      纸张: a4|a3|letter 或自定义 "W,H[mm|in]"
+  -d, --dpi INTEGER         输出 DPI
+```
+
+## YAML 结构
+
+### 组织架构图 (org)
+
+```yaml
+meta:
+  type: org
+  title: "组织架构"
+  theme: corporate
+  papersize: a4
+  dpi: 150
+  layout:                    # 全局布局参数
+    max_columns: 3           # 底族每行最多数
+    nodesep: 0.3             # 同行节点间距 (英寸)
+    ranksep: 0.6             # 行间距 (英寸)
+    block_pad: 0.15          # block 内边距
+    row_gap: 1               # 换行间距 (minlen)
+    # D2 专用
+    deputy_gap: 40           # 中心领导框内间距
+    wrap_width: 12           # 部门名自动换行宽度（0=不换）
+    dept_gap: 6              # 板块内部门间距
+    dept_width: 150          # 部门节点宽度
+
+groups:
+  - level: 0
+    label: "权力机构"
+    gap: 0.8                 # 到下层间距
+    nodes:
+      - id: 股东大会
+        title: "股东大会"
+        style: large         # large | default | external
+
+  - level: 1
+    label: "决策层"
+    blocks:
+      - id: 专业委员会
+        position: right      # right=同行右侧 | bottom=下一行 | left=同行左侧
+        max_columns: 3       # 块内每行节点数
+        block_align: left    # left | center
+        edge_from: 董事会    # 箭头到块边框
+        nodes:
+          - id: 战略委员会
+            title: "战略委员会"
+
+  - level: 2
+    gap: 1.5
+    nodesep: 3               # 本层节点间距 (覆盖全局)
+    nodes:
+      - id: 业务运营
+        title: "业务运营"
+        style: large
+        reports_to: 总经理   # 自动连线
+
+  - level: 3
+    blocks:
+      - id: 业务运营板块
+        position: bottom
+        max_columns: 2
+        edge_from: 业务运营
+        nodes:
+          - id: 债贷业务部
+            title: "债贷业务部"
+```
+
+### OrgNode 字段
+
+| 字段 | 说明 |
+|------|------|
+| `id` | 唯一标识 |
+| `title` | 显示标题，`\n` 换行 |
+| `name` | 副标题 (可选) |
+| `role` | 小字职务 (可选) |
+| `style` | `large`(居中加粗) / `default` / `external`(橙色) |
+| `reports_to` | 上级节点 id |
+| `is_cluster_head` | 板块标题 (仅 block 内) |
+
+### OrgGroup 布局参数
+
+| 字段 | 说明 |
+|------|------|
+| `gap` | 到下层垂直间距 |
+| `offset` | 水平偏移 (英寸) |
+| `nodesep` | 本层节点间距 (覆盖全局) |
+| `max_columns` | blocks 每行数 (覆盖全局) |
+| `max_right_columns` | right_nodes 每行数 |
+
+### OrgBlock 字段
+
+| 字段 | 说明 |
+|------|------|
+| `position` | `right` / `bottom` / `left` |
+| `max_columns` | 块内每行节点数 |
+| `row_gap` | 块内换行间距 (minlen) |
+| `block_align` | `left` / `center` |
+| `edge_from` | 箭头源节点 id |
+
+## 纸张尺寸
+
+| 预设 | 尺寸 |
+|------|------|
+| a4 | 210×297mm |
+| a3 | 297×420mm |
+| letter | 8.5×11in |
+| 自定义 | `"200,260"` (mm) 或 `"8.5,11in"` |
+
+## 输出文件
+
+| 引擎 | 格式 | 文件 |
+|------|------|------|
+| D2 | d2 | `name.d2` (源码) + `name_d2.svg` |
+| DOT | png, pdf, svg | `name.png`, `name.svg` |
+| DOT | html | `name.html` |
+| Excalidraw | excalidraw | `name.excalidraw` + `name_ex.png` |
+
+## 项目结构
+
+```
+structviz/
+├── pyproject.toml
+├── README.md
+├── examples/
+│   ├── equity_sample.yaml
+│   ├── org_siku.yaml
+│   └── org_bingong.yaml
+└── structviz/
+    ├── models.py               # Pydantic 模型
+    ├── themes.py               # 主题 + 纸张
+    ├── cli.py                  # CLI 入口
+    ├── render.py               # DOT 渲染
+    ├── d2_render.py            # D2 渲染 + 直角后处理
+    ├── html_wrapper.py         # HTML 包装
+    ├── excalidraw_render.py    # Excalidraw → PNG
+    └── generators/
+        ├── equity.py           # 股权图 DOT
+        ├── org.py              # 组织架构 DOT
+        ├── d2.py               # 组织架构 D2
+        └── excalidraw.py       # 组织架构 Excalidraw
+```
+
+## 许可
+
+MIT

structviz-0.2/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "structviz"
+version = "0.2"
+description = "声明式股权图与组织架构图生成工具 — YAML 驱动，D2/Graphviz/Excalidraw 三引擎"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+dependencies = [
+    "pyyaml>=6.0",
+    "pydantic>=2.0",
+    "graphviz>=0.20",
+    "click>=8.0",
+    "jinja2>=3.0"
+]
+
+[project.scripts]
+structviz = "structviz.cli:main"
+
+[tool.setuptools.packages.find]
+include = ["structviz*"]

structviz-0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

structviz-0.2/structviz/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1"

structviz-0.2/structviz/cli.py

@@ -0,0 +1,92 @@
+import click
+import yaml
+import os
+import json
+from .models import EquityChart, OrgChart
+from .generators import generate_equity_dot, generate_org_dot, generate_org_excalidraw, generate_org_d2
+from .render import render_dot
+from .html_wrapper import generate_html
+from .excalidraw_render import render_excalidraw_to_png
+from .d2_render import render_d2
+
+@click.command()
+@click.argument('yaml_file', type=click.Path(exists=True))
+@click.option('-t', '--type', 'chart_type', required=True,
+              type=click.Choice(['equity', 'org']), help='Chart type')
+@click.option('-f', '--formats', default='png',
+              help='Comma-separated output formats (png,pdf,svg,html,excalidraw,d2)')
+@click.option('-o', '--output', default='output/', help='Output directory')
+@click.option('-p', '--papersize', default=None,
+              help='Paper preset (a4/a3/letter) or custom "W,H[mm|in]" '
+                   'e.g. "210,297" or "8.5,11in" (overrides YAML)')
+@click.option('-d', '--dpi', default=None, type=int,
+              help='Output DPI (overrides YAML meta.dpi)')
+def main(yaml_file, chart_type, formats, output, papersize, dpi):
+    """Generate charts from YAML definition."""
+    with open(yaml_file, 'r', encoding='utf-8') as f:
+        data = yaml.safe_load(f)
+
+    os.makedirs(output, exist_ok=True)
+    base_name = os.path.splitext(os.path.basename(yaml_file))[0]
+    output_base = os.path.join(output, base_name)
+
+    if chart_type == 'equity':
+        chart = EquityChart(**data)
+    elif chart_type == 'org':
+        chart = OrgChart(**data)
+    else:
+        raise click.BadParameter("type must be equity or org")
+
+    fmt_list = [f.strip() for f in formats.split(',')]
+
+    # Excalidraw path
+    if 'excalidraw' in fmt_list:
+        if chart_type == 'org':
+            json_str = generate_org_excalidraw(chart, paper_size=papersize or chart.meta.papersize,
+                                                dpi=dpi or chart.meta.dpi)
+            path = output_base + '.excalidraw'
+            with open(path, 'w', encoding='utf-8') as f:
+                f.write(json_str)
+            png_path = output_base + '_ex.png'
+            render_excalidraw_to_png(json_str, png_path)
+            click.echo(f"Excalidraw saved to {path} + {png_path}")
+        else:
+            click.echo("Excalidraw only supports org charts currently.")
+
+    # D2 path
+    if 'd2' in fmt_list and chart_type == 'org':
+        d2_source = generate_org_d2(chart)
+        d2_path = output_base + '.d2'
+        with open(d2_path, 'w', encoding='utf-8') as f:
+            f.write(d2_source)
+        svg_path = render_d2(d2_source, output_base + '_d2.svg')
+        click.echo(f"D2 saved to {d2_path} + {svg_path}")
+
+    # DOT path (png, pdf, svg, html)
+    dot_formats = [f for f in fmt_list if f not in ('excalidraw', 'html', 'd2')]
+    if dot_formats:
+        if chart_type == 'equity':
+            dot_source = generate_equity_dot(chart, paper_size=papersize or chart.meta.papersize,
+                                              dpi=dpi or chart.meta.dpi)
+        else:
+            dot_source = generate_org_dot(chart, paper_size=papersize or chart.meta.papersize,
+                                           dpi=dpi or chart.meta.dpi)
+        render_dot(dot_source, output_base, dot_formats)
+
+    if 'html' in fmt_list:
+        svg_path = output_base + '.svg'
+        if not os.path.exists(svg_path):
+            if chart_type == 'equity':
+                ds = generate_equity_dot(chart, paper_size=papersize or chart.meta.papersize,
+                                          dpi=dpi or chart.meta.dpi)
+            else:
+                ds = generate_org_dot(chart, paper_size=papersize or chart.meta.papersize,
+                                       dpi=dpi or chart.meta.dpi)
+            render_dot(ds, output_base, ['svg'])
+        generate_html(svg_path, chart.meta.title, output_base + '.html')
+
+    if dot_formats or 'html' in fmt_list:
+        click.echo(f"Chart generated in {output}")
+
+if __name__ == '__main__':
+    main()

structviz-0.2/structviz/d2_render.py

@@ -0,0 +1,169 @@
+"""D2 渲染器：编译 D2 源码 → SVG，含直角线后处理"""
+
+import subprocess
+import tempfile
+import os
+import re
+import xml.etree.ElementTree as ET
+
+
+def render_d2(d2_source: str, output_path: str, cleanup: bool = True) -> str:
+    """编译 D2 源码到 SVG，返回输出文件路径"""
+    # 写临时文件
+    with tempfile.NamedTemporaryFile(mode='w', suffix='.d2', delete=False) as f:
+        tmp_d2 = f.name
+        f.write(d2_source)
+
+    svg_path = output_path
+    if not svg_path.endswith('.svg'):
+        svg_path = output_path + '.svg'
+
+    try:
+        result = subprocess.run(
+            ['d2', '--pad=0', '--layout=elk', tmp_d2, svg_path],
+            capture_output=True, text=True, timeout=60
+        )
+        if result.returncode != 0:
+            raise RuntimeError(f"d2 compile failed: {result.stderr}")
+
+        # SVG 后处理
+        _post_process_svg(svg_path)
+
+    finally:
+        if cleanup:
+            os.unlink(tmp_d2)
+
+    return svg_path
+
+
+def _flatten_tspan(content: str) -> str:
+    """把 <text> 内的 <tspan> 多行拆成独立 <text>，兼容 resvg"""
+    def replace_tspan(match):
+        full = match.group(0)
+        attrs = match.group(1)
+        # 提取属性
+        x_val = re.search(r'x="([^"]*)"', attrs).group(1)
+        y_val = re.search(r'y="([^"]*)"', attrs).group(1)
+        fill = re.search(r'fill="([^"]*)"', attrs)
+        fill = fill.group(1) if fill else '#0A0F25'
+        base_y = float(y_val)
+
+        # 保留 class 和 style
+        cls = re.search(r'class="([^"]*)"', attrs)
+        style = re.search(r'style="([^"]*)"', attrs)
+        extra = f'class="{cls.group(1)}"' if cls else ''
+        if style:
+            extra += f' style="{style.group(1)}"'
+            ta = re.search(r'text-anchor:(\w+)', style.group(1))
+            anchor = ta.group(1) if ta else 'middle'
+        else:
+            anchor = 'middle'
+
+        # 逐行生成独立 <text>
+        result = []
+        current_y = base_y
+        for ts in re.finditer(r'<tspan[^>]*dy="([^"]*)"[^>]*>([^<]*)</tspan>', full):
+            current_y += float(ts.group(1))
+            result.append(
+                f'<text x="{x_val}" y="{current_y:.1f}" fill="{fill}" '
+                f'{extra} text-anchor="{anchor}">{ts.group(2)}</text>'
+            )
+        return '\n'.join(result) if result else full
+
+    # 逐个 <text>...</text> 处理，只替换含 <tspan> 的
+    def patch(s):
+        if '<tspan' not in s:
+            return s
+        m = re.match(r'<text(\s[^>]*)>(.*?)</text>', s, re.DOTALL)
+        if m:
+            return replace_tspan(m)
+        return s
+
+    return re.sub(
+        r'<text\s[^>]*>.*?</text>',
+        lambda m: patch(m.group(0)),
+        content,
+        flags=re.DOTALL
+    )
+
+
+def _post_process_svg(svg_path: str):
+    """SVG 后处理：去嵌套、去 legend、斜线转直角"""
+    with open(svg_path, 'r', encoding='utf-8') as f:
+        content = f.read()
+
+    # 1. 剥离 XML 声明
+    xml_decl = ''
+    if content.startswith('<?xml'):
+        xml_end = content.index('?>') + 2
+        xml_decl = content[:xml_end]
+        content = content[xml_end:]
+
+    # 2. 去外层 SVG，把 xmlns 挪到内层
+    outer = re.match(r'<svg[^>]*>', content).group(0)
+    # 提取所有 xmlns 属性
+    xmlns_attrs = ' '.join(re.findall(r'xmlns(?::\w+)?="[^"]*"', outer))
+    content = re.sub(r'^<svg[^>]*>', '', content, count=1)
+    # 给内层 SVG 补上 xmlns
+    content = re.sub(r'^(<svg)\b', r'\1 ' + xmlns_attrs + ' ', content, count=1)
+    content = re.sub(r'</svg>$', '', content)
+
+    # 3. 删除 layout/routing 图例
+    for legend_class in ['bGF5b3V0', 'cm91dGluZw==']:
+        while True:
+            pattern = f'<g class="{legend_class}">'
+            idx = content.find(pattern)
+            if idx == -1:
+                break
+            depth = 1
+            pos = idx + len(pattern)
+            while depth > 0:
+                ot = content.find('<g ', pos)
+                ct = content.find('</g>', pos)
+                if ot >= 0 and ot < ct:
+                    depth += 1
+                    pos = ot + 3
+                else:
+                    depth -= 1
+                    pos = ct + 4
+            content = content[:idx] + content[pos:]
+
+    # 4. tspan 多行拆成独立 <text>（兼容 resvg）
+    content = _flatten_tspan(content)
+
+    # 5. 查找板块中心 x（font-size:24px 的容器标题）
+    plate_centers = {}
+    for m in re.finditer(r'<text x="([^"]*)" y="([^"]*)"[^>]*font-size:24px[^>]*>([^<]*)</text>', content):
+        plate_centers[m.group(3)] = float(m.group(1))
+
+    # 5. 连接线转直角 + 终点对齐板块中心
+    def fix_path(match):
+        d = match.group(1)
+        parts = d.split()
+        if len(parts) != 6 or parts[0] != 'M' or parts[3] != 'L':
+            return match.group(0)
+
+        x1, y1 = float(parts[1]), float(parts[2])
+        x2, y2 = float(parts[4]), float(parts[5])
+        y_mid = (y1 + y2) / 2
+
+        # 只对到达板块区域的连线（y2 > 0）做中心对齐
+        if y2 > 0 and plate_centers:
+            best_dist = 500
+            target_x = x2
+            for cx in plate_centers.values():
+                dist = abs(x2 - cx)
+                if dist < best_dist:
+                    best_dist = dist
+                    target_x = cx
+        else:
+            target_x = x2
+
+        return f'd="M {x1} {y1} L {x1} {y_mid} L {target_x} {y_mid} L {target_x} {y2}"'
+
+    content = re.sub(r'd="(M [^"]*)"', fix_path, content)
+
+    # 6. 写回
+    content = xml_decl + content
+    with open(svg_path, 'w', encoding='utf-8') as f:
+        f.write(content)