跳转到主要内容

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》配置文件格式的信息,请参阅规范文本设置示例部分。

规范文本设置示例

有一些示例可用。您可以在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许可证2.0

项目详情


下载文件

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

源码分发

本发行版本没有提供源码分发文件。请参阅生成分发存档的教程。

构建分发

blockdiaglite-3.1.2-py3-none-any.whl (2.7 MB 查看哈希值)

上传时间 Python 3

支持