textdraw 0.2.0

A small tool for drawing boxes and lines on the terminal

textdraw

textdraw is a Python library for drawing styled Unicode boxes and diagrams. Paths between points can be generated via an A* path-finding algorithm, and text objects can be composed to create complex layouts.

• Features
• Installation
• Examples
  • Boxed Hello World
  • Connecting boxes
  • Multiple connected boxes
  • A Complex Example
• Future Plans
• Contributing

Features

• Unicode box-drawing with light, heavy, and double borders
• Automatic path-finding powered by Rust backend
• Flexible padding and justification for text boxes
• Support for cleanly merging path intersections

Installation

pip install textdraw

Or with uv:

uv pip install textdraw

Examples

Boxed Hello World

from textdraw import Box, render


box = Box('Hello, world', style='italic', border_style='bold blue', line_style='double', padding=(1, 2, 1, 2))
print(render(box))

Connecting boxes

from textdraw import Box, Pixel, TextPath, render, Point


a = Box('A', (-20, 10), border_style='green', padding=(0, 1, 0, 1))
b = Box('B', (0, 0), border_style='red', padding=(0, 1, 0, 1))
print(a.bbox)
start_node = Pixel('', a.bbox.bottom_right + Point(1, 0), style='red')
end_node = Pixel('◼', b.bbox.top_left - Point(1, 0), style='green')
path = TextPath(
    a.bbox.bottom_right + Point(1, -1),
    b.bbox.top_left - Point(2, 0),
    style='dimmed',
    start_direction='up',
    end_direction='right',
    bend_penalty=20,
)
print(render(a, b, start_node, end_node, path))

Multiple connected boxes

from textdraw import Box, TextPath, render


boxes = {
    'A': (0, 0),
    'B': (30, 0),
    'C': (0, -8),
    'D': (30, -8),
    'E': (15, -4),
    'F': (15, -12),
}
objs = []
coords = {}
for label, (x, y) in boxes.items():
    box = Box(label, (x, y), border_style='bold white', style='bold', line_style='heavy', padding=(0, 1, 0, 1))
    objs.append(box)
    coords[label] = box.bbox.center

paths = [
    ('A', 'B', 'red'),
    ('A', 'C', 'green'),
    ('B', 'D', 'blue'),
    ('C', 'D', 'magenta'),
    ('A', 'E', 'yellow'),
    ('F', 'E', 'cyan'),
    ('E', 'D', 'bright_blue'),
]

for start, end, color in paths:
    path = TextPath(coords[start], coords[end], style=color, bend_penalty=0, line_style='heavy')
    objs.append(path)

print(render(*reversed(objs))) # reversed to put boxes on top of paths

A Complex Example

from textdraw import BoundingBox, Box, Pixel, PixelGroup, Point, TextPath, duplicate_shifted, multipath, render


class LetterBox:
    def __init__(self, letter: str, x: int, y: int):
        self.box = Box(letter, (x, y), padding=(0, 1, 0, 1))
        self.c_right = self.box.bbox.center_right + Point(1, 0)
        self.c_left = self.box.bbox.center_left - Point(1, 0)
        self.c_top = self.box.bbox.top_center + Point(0, 1)
        self.c_bottom = self.box.bbox.bottom_center - Point(0, 1)
        barrier = Pixel('⎚', style='blinkfast red', weight=None)
        self.barriers = PixelGroup(
            [
                barrier.duplicate(self.c_left - Point(0, 1)),
                barrier.duplicate(self.c_left + Point(0, 1)),
                barrier.duplicate(self.c_right - Point(0, 1)),
                barrier.duplicate(self.c_right + Point(0, 1)),
                barrier.duplicate(self.c_bottom - Point(1, 0)),
                barrier.duplicate(self.c_bottom + Point(1, 0)),
                barrier.duplicate(self.c_top - Point(1, 0)),
                barrier.duplicate(self.c_top + Point(1, 0)),
            ]
        )

a = LetterBox('a', 0, 0)
b = LetterBox('b', 20, -8)
c = LetterBox('c', 3, -10)
bbox = BoundingBox.wrap(a.box, b.box, c.box)
bbox.top += 7
bbox.bottom -= 7
bbox.left -= 7
bbox.right += 7

all_barriers = [a.barriers, b.barriers, c.barriers, a.box, b.box, c.box]
paths = []
paths.append(
    TextPath(
        a.c_right,
        b.c_top,
        style='dimmed',
        weight=20,
        bend_penalty=20,
        environment=paths,
        barriers=all_barriers,
        bbox=bbox,
    )
)
paths.append(
    TextPath(
        a.c_bottom,
        b.c_left,
        style='green',
        weight=20,
        bend_penalty=20,
        environment=paths,
        barriers=all_barriers,
        bbox=bbox,
    )
)

paths.append(
    TextPath(
        a.c_left,
        c.c_top,
        style='blue',
        weight=20,
        bend_penalty=20,
        environment=paths,
        barriers=all_barriers,
        bbox=bbox,
    )
)

paths.append(
    TextPath(
        b.c_bottom,
        c.c_left,
        style='red',
        line_style='double',
        weight=20,
        bend_penalty=20,
        environment=paths,
        barriers=all_barriers,
        bbox=bbox,
    )
)
shared_paths = multipath(
    [c.c_bottom, b.c_left, a.c_top],
    [a.c_right, c.c_right, b.c_right],
    style='yellow',
    line_style='heavy',
    bend_penalty=20,
    environment=paths,
    barriers=all_barriers,
    bbox=bbox,
    optimize=True,
)
objs = [a.box, b.box, c.box, *paths, *shared_paths]
bbox = BoundingBox.wrap(*objs)
objs_shifted = duplicate_shifted(
    [*objs, a.barriers, b.barriers, c.barriers],
    Point(bbox.width + 3, 0),
)
print(render(*objs, *objs_shifted))

Future Plans

This project was mostly a tool I wanted to create for a graph-drawing project. However, there are some features that would be beneficial:

• Combination characters like ╤ to combine different path styles or connect paths with boxes directly (the latter can be done but only manually)
• A convention to use for placing arrowheads at the ends of TextPaths. Currently, this can be done manually with Pixels and the arrow function.

Contributing

I'm open to any contributions. Please create an issue and/or pull request, I'll try to respond quickly.