跳转到主要内容

blockdiag从文本生成块图图像

项目描述

blockdiag 从规范文本文件生成块图图像文件。

GitHub Action CI build status Latest PyPI version Number of PyPI downloads

功能

  • 从类似于dot的文本生成块图(基本功能)。

  • 对节点标签进行多语言支持(仅支持utf-8)。

您可以在 blockdiag.com 上找到一些示例和生成的图像。

设置

使用pip

$ sudo pip install blockdiag

如果您想导出为PDF格式,请提供pdf参数

$ sudo pip install "blockdiag[pdf]"

复制并修改ini文件。示例

$ cp <blockdiag installed path>/blockdiag/examples/simple.diag .
$ vi simple.diag

有关 simpla.diag 配置文件格式的信息,请参阅 spec-text设置示例 部分。

spec-text设置示例

有一些示例可用。您可以在 blockdiag.com 上找到更多示例。

simple.diag

simple.diag 简单地通过类似 dot 的文本格式定义节点和转换

diagram admin {
  top_page -> config -> config_edit -> config_confirm -> top_page;
}

screen.diag

screen.diag 是一个更复杂的示例。diaglam 节点有可选的标签和一些转换

diagram admin {
  top_page [label = "Top page"];

  foo_index [label = "List of FOOs"];
  foo_detail [label = "Detail FOO"];
  foo_add [label = "Add FOO"];
  foo_add_confirm [label = "Add FOO (confirm)"];
  foo_edit [label = "Edit FOO"];
  foo_edit_confirm [label = "Edit FOO (confirm)"];
  foo_delete_confirm [label = "Delete FOO (confirm)"];

  bar_detail [label = "Detail of BAR"];
  bar_edit [label = "Edit BAR"];
  bar_edit_confirm [label = "Edit BAR (confirm)"];

  logout;

  top_page -> foo_index;
  top_page -> bar_detail;

  foo_index -> foo_detail;
               foo_detail -> foo_edit;
               foo_detail -> foo_delete_confirm;
  foo_index -> foo_add -> foo_add_confirm -> foo_index;
  foo_index -> foo_edit -> foo_edit_confirm -> foo_index;
  foo_index -> foo_delete_confirm -> foo_index;

  bar_detail -> bar_edit -> bar_edit_confirm -> bar_detail;
}

用法

执行 blockdiag 命令

$ blockdiag simple.diag
$ ls simple.png
simple.png

需求

  • Python 3.7 或更高版本

  • Pillow 3.0 或更高版本

  • funcparserlib 1.0.0a0 或更高版本

  • reportlab(可选)

  • wand 和 imagemagick(可选)

  • setuptools

许可

Apache License 2.0

项目详情


发布历史 发布通知 | RSS 源

下载文件

下载适合您平台的文件。如果您不确定该选择哪个,请了解更多关于 安装包 的信息。

源代码分发

blockdiag-3.0.0.tar.gz (2.7 MB 查看哈希值)

上传时间 源代码

构建分发

blockdiag-3.0.0-py3-none-any.whl (2.7 MB 查看哈希值)

上传时间 Python 3

由以下支持