ADia v4.1 documentation!

PyPI GitHub Workflow Status Coveralls CPython >= 3.6 Brython >= 3.9.5 GitHub forks

About

ADia is a language for ASCII diagrams. Currently, only sequence diagram is supported. But the roadmap is to implement two additional diagram types: fork/join and class.

adia.print('''
  diagram: Foo
  sequence:
  foo -> bar: Hello World!
''')

DIAGRAM: Foo

+-----+             +-----+
| foo |             | bar |
+-----+             +-----+
   |                   |
   |~~~Hello World!~~~>|
   |                   |
   |<------------------|
   |                   |
+-----+             +-----+
| foo |             | bar |
+-----+             +-----+

See also

adia.diagram(), adia.print() and adia.Diagram.

Live Demo

Try the ADia Live Demo.

Install

It’s higly recommended to use a virual-env utility for example: virtualenvwrapper before doing anything.

$ pip install adia

Or, install the latest version from the source:

$ pip install git+https://github.com/pylover/adia

Command Line Interface

$ adia << EOF
diagram: Foo
sequence:
foo -> bar: Hello
EOF

Or feed one or more filename(s):

$ adia file1.adia file2.adia fileN.adia > foo.txt

Issue adia --help for more info.

Contents

Indices and tables