blockdiag 1.1.5

blockdiag is a Python tool to generate block-diagram image file from spec-text file.

Setup

by easy_install

Make environment:

 easy_install blockdiag

by buildout

Make environment:

 hg clone http://bitbucket.org/tk0miya/blockdiag
 cd blockdiag
 python bootstrap.py
 bin/buildout

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.

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


Product's homepage

Here are some key features of "blockdiag":

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

Requirements:

· Python
· PIL
· funcparserlib
· setuptools or distriubte

What's New in This Release: [ read full changelog ]

· Embed source code to SVG document as description
· Fix bugs