UML Sequence diagram generator from text input
Project description
umlsequence
UML Sequence Diagrams Generator - Commandline tool to generate diagrams as images in various formats (SVG, PNG, JPG, PDF, etc.) from source text files.
This is a pure-Python rewrite of the https://github.com/pbauermeister/umlsequence project, which was itself based on umlgraph by Diomidis Spinellis.
Source text files are in the so-called "umlsequence" syntax.
Umlsequence syntax example:
# objects definitions
E : # External Messages
T : t:thread
O : :Toolkit
P :
# messages and activations
E -> T+ a1:run(3)
T -> O+ run()
O >callbackLoop()
# creation
O+ :> P p:Peer
# message with response
O- => P result=handleExpose()
# destruction
O #> P
# deactivation
T- O-
Syntax
See https://github.com/pbauermeister/umlsequence2/tree/master/doc/README.md.
Examples
See https://github.com/pbauermeister/umlsequence2/tree/master/examples/README.md.
Dependencies
- Python3
- Python libraries: svgwrite, reportlab
Installing via pip3
[sudo] pip3 install umlsequence2
Usage
umlsequence2 -h
says:
usage: umlsequence2 [-h] [--output-file OUTPUT_FILE] [--markdown]
[--format FORMAT] [--percent-zoom PERCENT_ZOOM]
[--background-color BACKGROUND_COLOR] [--debug]
[INPUT_FILE]
UML sequence command-line utility, version 2. (C) Copyright 2021 by Pascal
Bauermeister. Converts a textual UML sequence description into a graphic
file. See https://github.com/pbauermeister/umlsequence2/tree/master/examples
for examples.
positional arguments:
INPUT_FILE UML sequence input file; if omitted, stdin is used
optional arguments:
-h, --help show this help message and exit
--output-file OUTPUT_FILE, -o OUTPUT_FILE
output file name; pass '-' to use stdout; if omitted,
use INPUT_FILE base name with '.svg' extension, or
stdout
--markdown, -m consider snippets between opening marker:
```umlsequence OUTFILE, and closing marker: ```
--format FORMAT, -f FORMAT
output format: any supported by ImageMagick; default
is ps
--percent-zoom PERCENT_ZOOM, -p PERCENT_ZOOM
magnification percentage; default is 100
--background-color BACKGROUND_COLOR, -b BACKGROUND_COLOR
background color name (including 'none' for
transparent) in web color notation; see
https://developer.mozilla.org/en-
US/docs/Web/CSS/color_value for a list of valid
names; default is white
--debug emits debug messages
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
umlsequence2-2.0.3.post2.tar.gz
(26.2 kB
view hashes)
Built Distribution
Close
Hashes for umlsequence2-2.0.3.post2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28930ad35f350aad1a6ee10a8169e16ab9af531c2837c03f6bf7a7b09a4dc671 |
|
MD5 | 37aeec261bb42729906023b3471d1065 |
|
BLAKE2b-256 | 3074f3614f1566e11f619ec91fc1126ffa28d4e117f851d57f6d4a3f5c1a5386 |