koala-diagrams 1.2.2

Koala is a DSL and SVG compiler for structured concept diagrams.

Koala

Koala is a DSL for generating diagrams from structured text.

Write once, render in multiple layouts.

Español

Quick Example

Write this:

@theme jungle

main:: 1 Biology
Study of life.

hl:: contains -> 1.1 Cell
Basic unit of life.

1.2 Genetics
Study of heredity.

Then run:

koala compile example.txt --layout tree

Result

Installation

Install from PyPI:

pip install koala-diagrams==1.2.1

Or with pipx:

pipx install koala-diagrams==1.2.1

Usage

CLI

koala compile docs/examples/tree.txt --layout tree
koala compile docs/examples/radial.txt --layout radial --theme jungle --size square
koala inspect docs/examples/tree.txt
koala validate docs/examples/radial.txt --strict

Python

import koala

result = koala.compile(
    "docs/examples/radial.txt",
    layout="radial",
    theme="academic",
    size="square",
)

print(result.output_svg)

DSL Syntax

Koala uses a simple line-based DSL:

[kind::] [relation ->] number title

Example:

1 Main Concept
contains -> 1.1 Child Node
hl:: 1.2 Highlighted Node

• Full syntax guide
• Authoring tutorial
• Examples

Features

• Simple hierarchical DSL
• Multiple layouts (tree, radial, synoptic)
• Theme system
• CLI and Python API
• SVG output

Multiple Layouts

Tree, radial, and synoptic layouts from the same source.

Philosophy

Koala is built around a simple idea:

The same source file should be able to drive multiple layouts and visual styles without rewriting the content.

License

MIT