Skip to main content

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

Project description

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 tk0miya.bitbucket.org .

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. You can get more examples at tk0miya.bitbucket.org .

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 2.4 or later (not support 3.x)

  • Python Imaging Library 1.1.6 or later.

  • funcparserlib 0.3.4 or later.

  • setuptools or distriubte.

License

Python Software Foundation License.

History

0.6.3 (2011-01-15)

  • Fix bugs

0.6.2 (2011-01-08)

  • Fix bugs

0.6.1 (2011-01-07)

  • Implement ‘folded’ attribute for edge

  • Refactor layout engine

0.6 (2011-01-02)

  • Support nested groups.

0.5.5 (2010-12-24)

  • Specify direction of edges as syntax (->, –, <-, <->)

  • Fix bugs.

0.5.4 (2010-12-23)

  • Remove debug codes.

0.5.3 (2010-12-23)

  • Support NodeGroup.label.

  • Implement –separate option (experimental)

  • Fix right-up edge overrapped on other nodes.

  • Support configration file: .blockdiagrc

0.5.2 (2010-11-06)

  • Fix unicode errors for UTF-8’ed SVG exportion.

  • Refactoring codes for running on GAE.

0.5.1 (2010-10-26)

  • Fix license text on diagparser.py

  • Update layout engine.

0.5 (2010-10-15)

  • Support background-image of node (SVG)

  • Support labels for edge.

  • Fix bugs.

0.4.2 (2010-10-10)

  • Support background-color of node groups.

  • Draw edge has jumped at edge’s cross-points.

  • Fix bugs.

0.4.1 (2010-10-07)

  • Fix bugs.

0.4 (2010-10-07)

  • Support SVG exporting.

  • Support dashed edge drawing.

  • Support background image of nodes (PNG only)

0.3.1 (2010-09-29)

  • Fasten anti-alias process.

  • Fix text was broken on windows.

0.3 (2010-09-26)

  • Add –antialias option.

  • Fix bugs.

0.2.2 (2010-09-25)

  • Fix edge bugs.

0.2.1 (2010-09-25)

  • Fix bugs.

  • Fix package style.

0.2 (2010-09-23)

  • Update layout engine.

  • Support group { … } sentence for create Node-Groups.

  • Support numbered badge on node (cf. A [numbered = 5])

0.1 (2010-09-20)

  • first release

Todos

Functionals

  • Specify shape of node (rounded rectangle, diamond, end-point, etc.)

  • Support other block diagram structure.

Known Issues

  • Fix some experimental features.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blockdiag-0.6.3.tar.gz (37.7 kB view details)

Uploaded Source

File details

Details for the file blockdiag-0.6.3.tar.gz.

File metadata

  • Download URL: blockdiag-0.6.3.tar.gz
  • Upload date:
  • Size: 37.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for blockdiag-0.6.3.tar.gz
Algorithm Hash digest
SHA256 6e046c6e1fdecb2b5b3ba8b04032f9775e168b3bc8d1a0c7085c499230e6813b
MD5 c5745c933951ebae7e4be49282c10cdb
BLAKE2b-256 0557bf7079ac4f6389ad1571dffac11e969e6f83c57addbf32f92f18f433c64d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page