blockdiag / seqdiag

Apache License 2.0
68 stars 14 forks source link

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

.. image:: https://drone.io/bitbucket.org/blockdiag/seqdiag/status.png :target: https://drone.io/bitbucket.org/blockdiag/seqdiag :alt: drone.io CI build status

.. image:: https://pypip.in/v/seqdiag/badge.png :target: https://pypi.python.org/pypi/seqdiag/ :alt: Latest PyPI version

.. image:: https://pypip.in/d/seqdiag/badge.png :target: https://pypi.python.org/pypi/seqdiag/ :alt: Number of PyPI downloads

Features

You can get some examples and generated images on blockdiag.com <http://blockdiag.com/en/seqdiag/index.html>__ .

Setup

Use easy_install or pip::

$ sudo easy_install seqdiag

Or

$ sudo pip seqdiag

Copy and modify ini file. example::

$ cp /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 <http://blockdiag.com/en/seqdiag/index.html>__ .

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

License

Apache License 2.0