File: README.rst

package info (click to toggle)
seqdiag 0.9.5+dfsg-1
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 460 kB
  • ctags: 251
  • sloc: python: 1,962; makefile: 11
file content (91 lines) | stat: -rw-r--r-- 1,956 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
`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
========

* 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 <http://blockdiag.com/seqdiag/build/html/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
============
* Python 2.6, 2.7, 3.2, 3.3, 3.4
* Pillow 2.2.1 or later
* funcparserlib 0.3.6 or later
* reportlab (optional)
* wand and imagemagick (optional)
* setuptools


License
=======
Apache License 2.0