Skip to main content

Turn any directed graph into colored ASCII art for your terminal

Project description

graphtty

PyPI downloads PyPI - Version Python versions

Turn any directed graph into colored ASCII art for your terminal. Pure Python, zero external dependencies.

Installation

pip install graphtty

Deep Agent (ocean theme)

Supervisor Agent (dracula theme)

More examples available in the screenshots/ directory.

Quick start

from graphtty import render

graph = {
    "nodes": [
        {"id": "start", "name": "User Input", "type": "entry"},
        {"id": "router", "name": "Router", "type": "condition"},
        {"id": "search", "name": "Web Search", "type": "tool"},
        {"id": "calc", "name": "Calculator", "type": "tool"},
        {"id": "respond", "name": "Respond", "type": "model"},
    ],
    "edges": [
        {"source": "start", "target": "router"},
        {"source": "router", "target": "search", "label": "search"},
        {"source": "router", "target": "calc", "label": "calc"},
        {"source": "search", "target": "respond"},
        {"source": "calc", "target": "respond"},
    ],
}

print(render(graph))
           ┌ entry ─────┐
           │ User Input │
           └─────┬──────┘
                 │
                 ▼
          ┌ condition ──┐
          │   Router    │
          └──────┬──────┘
         ┌search─└──calc───┐
         ▼                 ▼
  ┌ tool ──────┐    ┌ tool ──────┐
  │ Web Search │    │ Calculator │
  └──────┬─────┘    └──────┬─────┘
         └───────┌─────────┘
                 ▼
            ┌ model ──┐
            │ Respond │
            └─────────┘

Nodes support descriptions and nested subgraphs:

# Descriptions appear as extra lines inside the box
{"id": "a", "name": "LLM", "type": "model", "description": "gpt-4o"}

# Nested subgraphs render as boxes within boxes
{"id": "b", "name": "Pipeline", "type": "subgraph", "subgraph": {"nodes": [...], "edges": [...]}}

Apply a color theme:

from graphtty import render, RenderOptions, get_theme

print(render(graph, RenderOptions(theme=get_theme("monokai"))))

CLI

graphtty graph.json
graphtty graph.json --theme monokai
graphtty graph.json --ascii
graphtty graph.json --no-types

Themes

Ten built-in color themes:

default monokai ocean forest dracula solarized nord catppuccin gruvbox tokyo-night

graphtty --list-themes

JSON format

graphtty reads a simple JSON format:

{
  "nodes": [
    { "id": "a", "name": "Start", "type": "entry" },
    { "id": "b", "name": "Process", "type": "tool", "description": "optional detail" },
    { "id": "c", "name": "End", "type": "exit" }
  ],
  "edges": [
    { "source": "a", "target": "b", "label": "optional" },
    { "source": "b", "target": "c" }
  ]
}

Benchmarks

graphtty uses a custom Sugiyama-style layout engine and optimized canvas operations for fast rendering. Benchmarks across all 9 sample graphs (50 iterations each, Python 3.11):

Sample Avg (ms) Ops/sec
react-agent (4 nodes) 0.15 6,522
deep-agent (7 nodes) 0.31 3,161
function-agent (8 nodes) 0.36 2,806
workflow-agent (11 nodes) 0.42 2,370
world-map (15 nodes) 0.55 1,818
supervisor-agent (7+subs) 0.71 1,406
rag-pipeline (10 nodes) 0.74 1,347
etl-pipeline (12 nodes) 0.84 1,193
code-review (8+subs) 1.16 864

Run python scripts/benchmark.py to reproduce on your machine.

Related Projects

  • uipath-dev: Developer console for debugging and inspecting AI agents
  • uipath-python: Python SDK and CLI to build, test, and deploy AI agents

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

graphtty-0.1.4.tar.gz (479.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

graphtty-0.1.4-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file graphtty-0.1.4.tar.gz.

File metadata

  • Download URL: graphtty-0.1.4.tar.gz
  • Upload date:
  • Size: 479.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for graphtty-0.1.4.tar.gz
Algorithm Hash digest
SHA256 bb25d7a0dd5049cfb8c83fc2f229a694ed190f8d1c3865878e9972f51f142694
MD5 ccfe0e13359d380937c0d19725c1d58d
BLAKE2b-256 daa78f59da6e4bdd9ef12787d7692e7ebe91418edf19bf37bad2860cf6808e41

See more details on using hashes here.

Provenance

The following attestation bundles were made for graphtty-0.1.4.tar.gz:

Publisher: cd.yml on UiPath/graphtty

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file graphtty-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: graphtty-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for graphtty-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9df504449decaf456ccdafd7107220b1de9e8b8acea6630364d97c23c383776a
MD5 02aa118767edf2e62dc81c0884d88e7d
BLAKE2b-256 d43571db2d572f4cb642a5f28511121c034d7506397de746d913a8855747f117

See more details on using hashes here.

Provenance

The following attestation bundles were made for graphtty-0.1.4-py3-none-any.whl:

Publisher: cd.yml on UiPath/graphtty

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page