Skip to main content

graph-easy

A Python port of Graph::Easy, the Perl tool that lays out directed/undirected graphs and renders them as ASCII art (box-and-wire diagrams rendered in the terminal).

This project faithfully translates the original Perl implementation to Python, in order to provide the same functionality to Python users / as a native Python library and command-line tool.

Provenance & License

  • Original: Graph::Easy, Copyright (C) 2004 - 2008 by Tels (http://bloodgate.com/).
  • Upstream repository: https://github.com/ironcamel/Graph-Easy
  • This port is licensed under the GNU General Public License, version 2 or (at your option) any later version — the same license as the original Graph::Easy, because a port is a derivative work.

See LICENSE for the full LGPL/ GPL text.

Third-party color schemes

This product includes color specifications and designs developed by Cynthia Brewer (http://colorbrewer.org/), used under the Apache-Style Software License for ColorBrewer Color Schemes v1.1, © 2002 Cynthia Brewer, Mark Harrower, and The Pennsylvania State University. See the header of the original Graph::Easy::Attributes for the full notice.

Status

Actively-developed port. Currently implemented:

  • DSL parser: [ label ]/bare nodes, --> <-- <--> -- arrows, labelled edges (-- label -->), multiline labels (\n), comments
  • Layout engine: longest-path layering with orthogonal edge routing — chains, branches, merges and cycles all render correctly; independent components stack as separate diagrams
  • Edge line styles (faithful to upstream Parser::_edge_style): -- solid, .. dotted, == double, ~~ wave, ## bold, .-/..- dot-dash
  • Two output charsets: Unicode box-drawing by default (┌──┐ ──> ══ ║ ·), plain ASCII via --ascii

The heavier automatic layout engine (Graph::Easy::Layout grid solver) is a follow-up milestone.

Usage

$ printf '[ Bonn ] --> [ Berlin ] --> [ Hamburg ]\n' | graph-easy
┌──────┐         ┌────────┐         ┌─────────┐
│ Bonn │ ───────>│ Berlin │ ───────>│ Hamburg │
└──────┘         └────────┘         └─────────┘

Colours from fill/color attributes are on by default; use --no-color to disable, or --color auto to enable only on a TTY.

# plain-ASCII output
$ printf '[ A ] ..> [ B ]\n' | graph-easy --ascii
+---+         +---+
| A | .......>| B |
+---+         +---+

Development

$ python -m venv .venv && source .venv/bin/activate
$ pip install -e '.[dev]'
$ pytest

Acknowledgments

Thanks to Tels and the Graph::Easy contributors whose careful layout and rendering work this port builds upon.

Download files

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

Source Distribution

graph_easy-0.0.3.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

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

graph_easy-0.0.3-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file graph_easy-0.0.3.tar.gz.

File metadata

  • Download URL: graph_easy-0.0.3.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for graph_easy-0.0.3.tar.gz
Algorithm Hash digest
SHA256 ffe2a3461a3a94636a39efe315c4a3f4b810763450da81346217645823853471
MD5 5d1be60b5d7fba2f00eee09a4d62e261
BLAKE2b-256 d0b2104cc3f46ddd4a2f45b66a12b7d82733ab8f99481efc89b9f5f06f8ef043

See more details on using hashes here.

Provenance

The following attestation bundles were made for graph_easy-0.0.3.tar.gz:

Publisher: publish.yml on y9c/graph-easy-py

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

File details

Details for the file graph_easy-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: graph_easy-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for graph_easy-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 60be3390c2a192ce7cfbb007eaf37225407395d228a2128e77130fc630a44796
MD5 fe98d15e8a3687063399a51502de0b62
BLAKE2b-256 b2e365ecaf36eb1c41177582a61056a59466f731a1a7b6db906ec75cb1152440

See more details on using hashes here.

Provenance

The following attestation bundles were made for graph_easy-0.0.3-py3-none-any.whl:

Publisher: publish.yml on y9c/graph-easy-py

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

Release history Release notifications | RSS feed

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

This release

0.0.3 This release

2 files

0.0.2

2 files

0.0.1

2 files

Supported by

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