ASCII Tree Generator

0.3.3 · maintenance · verified Sun Apr 12

asciitree is a Python library that enables the drawing of tree structures using ASCII characters directly in the terminal. It is currently at version 0.3.3, with its last release in 2016, suggesting a maintenance or inactive release cadence.

Warnings

deprecated The library has not been updated since September 2016. While it functions, it may not receive further bug fixes or new features and might have compatibility issues with very recent Python versions or dependencies not yet discovered.
Fix: Consider testing thoroughly with your target Python environment. For new projects, evaluate more actively maintained alternatives if long-term support is crucial.
gotcha The library explicitly states support only for Python 3. Attempting to use it with Python 2 environments will likely result in errors.
Fix: Ensure your project's environment is running Python 3 or higher.
gotcha There are multiple Python, Go, and JavaScript libraries that share the 'asciitree' or 'ascii tree' name. Ensure you are importing and using the correct Python library 'asciitree' by Marc Brinkmann (mbr).
Fix: Always verify the PyPI package name and the GitHub repository (`mbr/asciitree`) to ensure you are using the intended library.

Install

pip install asciitree Install latest version

Imports

LeftAligned
```
from asciitree import LeftAligned
```
While some older examples or alternative libraries might use `ascii_tree`, the core library and its primary documentation use `from asciitree import LeftAligned` for rendering.

Quickstart

This quickstart demonstrates how to create a hierarchical dictionary structure, using `OrderedDict` for predictable child ordering, and then render it into an ASCII tree using the `LeftAligned` renderer.

from asciitree import LeftAligned
from collections import OrderedDict as OD

tree_data = {
    'root': OD([
        ('child1', {
            'grandchild1_1': {},
            'grandchild1_2': {'subgrandchild': {}}
        }),
        ('child2', {
            'grandchild2_1': {},
        }),
        ('child3', {})
    ])
}

tr = LeftAligned()
print(tr(tree_data))

view raw JSON →