blockdiag generate block-diagram image file from spec-text file.

Features

Generate block-diagram from dot like text (basic feature).
Multilingualization for node-label (utf-8 only).

You can get some examples and generated images on blockdiag.com .

Setup

Use pip:

$ sudo pip install blockdiag

If you want to export as PDF format, give pdf arguments:

$ sudo pip install "blockdiag[pdf]"

Copy and modify ini file. example:

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

Please refer to spec-text setting sample section for the format of the simpla.diag configuration file.

spec-text setting sample

Few examples are available. You can get more examples at blockdiag.com .

simple.diag

simple.diag is simply define nodes and transitions by dot-like text format:

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

screen.diag

screen.diag is more complexly sample. diaglam nodes have a alternative label and some transitions:

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;
}

Usage

Execute blockdiag command:

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

Requirements

Python 3.7 or later
Pillow 3.0 or later
funcparserlib 1.0.0a0 or later
reportlab (optional)
wand and imagemagick (optional)
setuptools

License

Apache License 2.0

Metadata

Release files for blockdiag 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for blockdiag 3.0.0
File	Size	Uploaded
blockdiag-3.0.0.tar.gz	2.7 MB	Dec 6, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for blockdiag 3.0.0
File	Interpreter	ABI	Platform	Reset
blockdiag-3.0.0-py3-none-any.whl 2.7 MB Dec 6, 2021	Python 3	none	any	Details

Total release size: 5.4 MB

Release files / blockdiag-3.0.0.tar.gz

Download URL	blockdiag-3.0.0.tar.gz
Size	2.7 MB
Tags	Source
SHA-256 checksum How to use checksums	`dee4195bb87d23654546ba2bf5091480dbf253b409891fce2cd527c91d00a3e2`
BLAKE2b-256 checksum How to use checksums	`b4ebe2a4b6d5bf7f7121104ac7a1fc80b5dfa86ba286adbd1f25bf32a090a5eb`
Upload date	Dec 6, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9`

Release files / blockdiag-3.0.0-py3-none-any.whl

Download URL	blockdiag-3.0.0-py3-none-any.whl
Size	2.7 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`4031bfae6a7f36071d733dec639987346e10f7871356ee2c7a221961c64961d8`
BLAKE2b-256 checksum How to use checksums	`cfcdb82f859a9ebc4d24c1a8b901a68df0d90aa717fd4d47d6166db9449dc0ff`
Upload date	Dec 6, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9`