structviz 0.2__py3-none-any.whl

structviz/models.py

@@ -0,0 +1,82 @@
+from pydantic import BaseModel, Field
+from typing import List, Optional, Literal
+
+class LayoutConfig(BaseModel):
+    max_columns: int = 0         # 每行最多 block 数，0=不限制
+    nodesep: float = 0.3         # 同行节点水平间距 (英寸)
+    ranksep: float = 0.6         # 行间垂直间距 (英寸)
+    block_pad: float = 0.15      # block 内左右内边距 (英寸)
+    row_gap: float = 1.0         # block 内换行间距 (minlen 倍数)
+    deputy_gap: int = 40         # 中心领导框内 主任/副主任 水平间距
+    wrap_width: int = 12         # 部门名称自动换行宽度 (字符数)，0=不换行
+    dept_gap: int = 6            # 板块内部门节点间距
+    dept_width: int = 150        # 部门节点宽度
+
+class Meta(BaseModel):
+    type: Literal["equity", "org"]
+    title: str = "Chart"
+    theme: str = "corporate"
+    layout: Optional[LayoutConfig] = None
+    papersize: Optional[str] = None    # 纸张预设: a4/a3/letter 等
+    dpi: Optional[int] = None          # 输出 DPI
+
+# ---------- 股权图模型 ----------
+class EquityNode(BaseModel):
+    id: str
+    label: str
+    shape: str = "box"
+    style: str = ""
+    fillcolor: str = ""
+    color: str = ""
+    fontcolor: str = ""
+
+class EquityEdge(BaseModel):
+    from_id: str = Field(alias="from")
+    to: str
+    label: str = ""
+    color: str = ""
+    penwidth: float = 1.0
+    style: str = "solid"
+
+class EquityChart(BaseModel):
+    meta: Meta
+    nodes: List[EquityNode]
+    edges: List[EquityEdge]
+
+# ---------- 组织架构图模型 ----------
+class OrgNode(BaseModel):
+    id: str
+    title: str
+    name: str = ""
+    role: str = ""
+    style: Literal["default", "external", "large"] = "default"
+    reports_to: Optional[str] = None
+    is_cluster_head: bool = False
+
+BlockPosition = Literal["left", "right", "bottom"]
+
+class OrgBlock(BaseModel):
+    id: str
+    position: BlockPosition = "bottom"
+    label: str = ""
+    nodes: List[OrgNode] = []
+    max_columns: Optional[int] = None   # 块内每行节点数
+    edge_from: Optional[str] = None     # 箭头到块边框 (lhead)
+    block_align: Literal["left", "center"] = "left"
+    row_gap: Optional[float] = None     # 块内换行间距 (覆盖全局)
+
+class OrgGroup(BaseModel):
+    level: int
+    label: str
+    nodes: List[OrgNode] = []              # 本层主要节点
+    right_nodes: List[OrgNode] = []        # 本层右侧对齐节点 (独立)
+    blocks: List[OrgBlock] = []            # 统一块: position 控制位置
+    max_columns: Optional[int] = None      # 本层 blocks 每行最多数
+    max_right_columns: Optional[int] = None
+    gap: Optional[float] = None            # 本层后垂直间距
+    offset: Optional[float] = None         # 本层水平偏移 (英寸)
+    nodesep: Optional[float] = None        # 本层节点水平间距 (覆盖全局)
+
+class OrgChart(BaseModel):
+    meta: Meta
+    groups: List[OrgGroup]

structviz/render.py

@@ -0,0 +1,20 @@
+import graphviz
+
+def render_dot(dot_source: str, output_path: str, formats: list):
+    """
+    使用 graphviz 库将 DOT 源码渲染为多种格式。
+    output_path 不含后缀，自动根据格式添加。
+    """
+    dot_file = output_path + ".dot"
+    with open(dot_file, 'w', encoding='utf-8') as f:
+        f.write(dot_source)
+
+    for fmt in formats:
+        if fmt == "dot":
+            continue
+        try:
+            src = graphviz.Source(dot_source)
+            src.format = fmt
+            src.render(output_path, cleanup=True)
+        except Exception as e:
+            print(f"Error rendering {fmt}: {e}")

structviz/themes.py

@@ -0,0 +1,99 @@
+import re
+
+# 纸张尺寸预设 (单位: 英寸，Graphviz size 属性要求英寸)
+# 宽高比: A系列 ≈ 1:√2, Letter/Legal 略宽
+PAPER_SIZES = {
+    "a4":     {"size": "8.27,11.69",  "ratio": "fill", "label": "A4 (210×297mm)"},
+    "a3":     {"size": "11.69,16.54", "ratio": "fill", "label": "A3 (297×420mm)"},
+    "a2":     {"size": "16.54,23.39", "ratio": "fill", "label": "A2 (420×594mm)"},
+    "a1":     {"size": "23.39,33.11", "ratio": "fill", "label": "A1 (594×841mm)"},
+    "a0":     {"size": "33.11,46.81", "ratio": "fill", "label": "A0 (841×1189mm)"},
+    "letter": {"size": "8.5,11",      "ratio": "fill", "label": "Letter (8.5×11in)"},
+    "legal":  {"size": "8.5,14",      "ratio": "fill", "label": "Legal (8.5×14in)"},
+    "tabloid": {"size": "11,17",      "ratio": "fill", "label": "Tabloid (11×17in)"},
+}
+
+def parse_paper_size(value: str) -> dict | None:
+    """解析纸张尺寸：预设名称或自定义 "宽,高[mm|in]"，默认单位 mm"""
+    if not value:
+        return None
+    if value in PAPER_SIZES:
+        return PAPER_SIZES[value]
+    m = re.match(r'^(\d+\.?\d*)\s*,\s*(\d+\.?\d*)\s*(mm|in)?$', value, re.IGNORECASE)
+    if not m:
+        return None
+    w, h, unit = float(m.group(1)), float(m.group(2)), (m.group(3) or 'mm').lower()
+    if unit == 'in':
+        return {"size": f"{w},{h}", "ratio": "fill", "label": f"Custom ({w}×{h}in)"}
+    else:
+        return {"size": f"{w/25.4:.2f},{h/25.4:.2f}", "ratio": "fill", "label": f"Custom ({w}×{h}mm)"}
+
+THEMES = {
+    "corporate": {
+        "node_default": {
+            "shape": "plaintext",
+            "fontname": "Helvetica,Arial,sans-serif",
+            "fontsize": "11"
+        },
+        "card_header_bg": "#2C3E50",
+        "card_header_font": "white",
+        "card_body_bg": "#FFFFFF",
+        "card_border_color": "#34495E",
+        "external_header_bg": "#E67E22",
+        "external_border": "#E67E22",
+        "edge_color": "#7F8C8D",
+        "edge_penwidth": 1.2,
+        "ranksep": 0.6,
+        "nodesep": 0.3,
+        "cluster_bg": "#F4F6F7",
+        "dept_fillcolor": "#EBF5FB",
+        "dept_border": "#2980B9",
+    },
+    "clean": {
+        "node_default": {
+            "shape": "box",
+            "style": "rounded,filled",
+            "fillcolor": "#F8F9FA",
+            "color": "#ADB5BD",
+            "fontname": "Helvetica",
+            "fontsize": "11"
+        },
+        "card_header_bg": "#6C757D",
+        "card_header_font": "white",
+        "card_body_bg": "#F8F9FA",
+        "card_border_color": "#ADB5BD",
+        "external_header_bg": "#FD7E14",
+        "external_border": "#FD7E14",
+        "edge_color": "#6C757D",
+        "edge_penwidth": 1.0,
+        "ranksep": 0.6,
+        "nodesep": 0.3,
+        "cluster_bg": "#FFFFFF",
+        "dept_fillcolor": "#F8F9FA",
+        "dept_border": "#ADB5BD",
+    },
+    "dark": {
+        "node_default": {
+            "shape": "box",
+            "style": "rounded,filled",
+            "fillcolor": "#343A40",
+            "color": "#495057",
+            "fontcolor": "white",
+            "fontname": "Helvetica",
+            "fontsize": "11"
+        },
+        "card_header_bg": "#212529",
+        "card_header_font": "#F8F9FA",
+        "card_body_bg": "#343A40",
+        "card_border_color": "#495057",
+        "external_header_bg": "#D6336C",
+        "external_border": "#D6336C",
+        "edge_color": "#ADB5BD",
+        "edge_penwidth": 1.2,
+        "ranksep": 0.6,
+        "nodesep": 0.3,
+        "cluster_bg": "#343A40",
+        "dept_fillcolor": "#343A40",
+        "dept_border": "#495057",
+    }
+}

structviz-0.2.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,18 @@
+structviz/__init__.py,sha256=Lgf9keBX7aG_JEFt6UYSyiFKcm-BYGtmk9ohpQhYpyk,20
+structviz/cli.py,sha256=3X3DOSTDOmkB5nny312c29QAgsBCMXZ9B9RycXtzzXs,4024
+structviz/d2_render.py,sha256=TDehGa-V2JUWG4e_Ibjf-ETsx9qyeEm3sDmQxGZxwJI,5623
+structviz/excalidraw_render.py,sha256=B9-uCuJT-2KdQB-68l1vkZCwdXRKzC1XNs10VpKCGQk,7546
+structviz/html_wrapper.py,sha256=9BgpzwugxHnHPYwfhiYwiijHgS0hhqpmxkIrhY4ot1o,871
+structviz/models.py,sha256=uqOuvSZ7Y2Mc7gBQhh0RMZ_IUrewsacda__rRTF3c1k,2920
+structviz/render.py,sha256=3Janxo1aVPnNqu6SiUSgLQhuyvDMdAfQQVWUNNGyf6s,626
+structviz/themes.py,sha256=iE5qy83Zmph4xezu-4btDlJ9Nn9r3_S7B2Yg8YKJxpo,3580
+structviz/generators/__init__.py,sha256=A0mGW-y57TdjTXYWpbwCesq0nlik3wE4byHTKA49xmo,154
+structviz/generators/d2.py,sha256=tGTc31Xf-TubGCFjsMAxCPlcgBYkfdBvDZvfGdutsvQ,7506
+structviz/generators/equity.py,sha256=8TPYCHzGiyPUeIaogNqtqQz_WleY4QceXdendM9W1EQ,1766
+structviz/generators/excalidraw.py,sha256=Z0YTWUzVpdL1Snyny1sKlcwUp6CJ15XkvW4ek54U8Tc,12603
+structviz/generators/org.py,sha256=yCSyDJKVEUM8wVWraJXlhTEgHelHtBbokHLV7EjOcIw,14550
+structviz-0.2.dist-info/METADATA,sha256=bGRlnHt_jvwCqGxolIn-NULqjSVs_ngCOkR1O7B2sQI,5581
+structviz-0.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+structviz-0.2.dist-info/entry_points.txt,sha256=zBH-_kOAemCA9u3GGLXUdEVEKILyg0tQFeQWBCGhjuI,49
+structviz-0.2.dist-info/top_level.txt,sha256=_mn-wwrd47HGVONU2Qg5lktCRhAzGccUsOhB8eeWQ94,10
+structviz-0.2.dist-info/RECORD,,

structviz-0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

structviz-0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+structviz = structviz.cli:main

structviz-0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+structviz