Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
examples/ | H | 03-May-2022 | - | 43 | 34 | |
src/ | H | 26-Jan-2020 | - | 2,926 | 2,146 | |
CHANGES.rst | H A D | 26-Jan-2020 | 4.5 KiB | 256 | 199 | |
LICENSE | H A D | 13-Jan-2020 | 11.1 KiB | 203 | 169 | |
MANIFEST.in | H A D | 26-Jan-2020 | 291 | 13 | 11 | |
PKG-INFO | H A D | 26-Jan-2020 | 3.7 KiB | 118 | 87 | |
README.rst | H A D | 13-Jan-2020 | 1.9 KiB | 90 | 60 | |
seqdiag.1 | H A D | 13-Jan-2020 | 2 KiB | 70 | 50 | |
setup.cfg | H A D | 26-Jan-2020 | 211 | 22 | 15 | |
setup.py | H A D | 26-Jan-2020 | 2.2 KiB | 76 | 66 | |
tox.ini | H A D | 13-Jan-2020 | 238 | 17 | 14 |
README.rst
1`seqdiag` generate sequence-diagram image file from spec-text file. 2 3.. image:: https://drone.io/bitbucket.org/blockdiag/seqdiag/status.png 4 :target: https://drone.io/bitbucket.org/blockdiag/seqdiag 5 :alt: drone.io CI build status 6 7.. image:: https://pypip.in/v/seqdiag/badge.png 8 :target: https://pypi.python.org/pypi/seqdiag/ 9 :alt: Latest PyPI version 10 11.. image:: https://pypip.in/d/seqdiag/badge.png 12 :target: https://pypi.python.org/pypi/seqdiag/ 13 :alt: Number of PyPI downloads 14 15 16Features 17======== 18 19* Generate sequence-diagram from dot like text (basic feature). 20* Multilingualization for node-label (utf-8 only). 21 22You can get some examples and generated images on 23`blockdiag.com`_ . 24 25Setup 26===== 27 28Use easy_install or pip:: 29 30 $ sudo easy_install seqdiag 31 32 Or 33 34 $ sudo pip seqdiag 35 36 37Copy and modify ini file. example:: 38 39 $ cp <seqdiag installed path>/blockdiag/examples/simple.diag . 40 $ vi simple.diag 41 42Please refer to `spec-text setting sample`_ section for the format of the 43`simpla.diag` configuration file. 44 45spec-text setting sample 46======================== 47 48Few examples are available. 49You can get more examples at 50`blockdiag.com <http://blockdiag.com/seqdiag/build/html/index.html>`_ . 51 52simple.diag 53------------ 54 55simple.diag is simply define nodes and transitions by dot-like text format:: 56 57 diagram { 58 browser -> webserver [label = "GET /index.html"]; 59 browser <-- webserver; 60 browser -> webserver [label = "POST /blog/comment"]; 61 webserver -> database [label = "INSERT comment"]; 62 webserver <-- database; 63 browser <-- webserver; 64 } 65 66 67Usage 68===== 69 70Execute seqdiag command:: 71 72 $ seqdiag simple.diag 73 $ ls simple.png 74 simple.png 75 76 77Requirements 78============ 79* Python 3.5 or later 80* blockdiag 1.5.0 or later 81* funcparserlib 0.3.6 or later 82* reportlab (optional) 83* wand and imagemagick (optional) 84* setuptools 85 86 87License 88======= 89Apache License 2.0 90