blockdiag / seqdiag

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

seqdiag generate sequence-diagram image file from spec-text file.

drone.io CI build status Latest PyPI version Number of PyPI downloads

Features

  • Generate sequence-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 easy_install or pip:

$ sudo easy_install seqdiag

Or

$ sudo pip seqdiag

Copy and modify ini file. example:

$ cp <seqdiag 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 {
  browser  -> webserver [label = "GET /index.html"];
  browser <-- webserver;
  browser  -> webserver [label = "POST /blog/comment"];
              webserver  -> database [label = "INSERT comment"];
              webserver <-- database;
  browser <-- webserver;
}

Usage

Execute seqdiag command:

$ seqdiag simple.diag
$ ls simple.png
simple.png

Requirements

  • Python 3.7 or later
  • blockdiag 1.5.0 or later
  • funcparserlib 0.3.6 or later
  • reportlab (optional)
  • wand and imagemagick (optional)
  • setuptools

License

Apache License 2.0

About

License:Apache License 2.0


Languages

Language:Python 97.9%Language:Roff 2.1%