Metadata-Version: 2.1
Name: netext
Version: 0.2.1
Summary: A graph (network) rendering library for the terminal.
Home-page: https://github.com/mahrz24/netext
License: MIT
Keywords: network,graph,terminal,rich
Author: Malte Klemm
Author-email: me@malteklemm.de
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: textual
Requires-Dist: bitarray (>=2.6.2,<3.0.0)
Requires-Dist: cachetools (>=5.3.0,<6.0.0)
Requires-Dist: grandalf (>=0.7,<0.8)
Requires-Dist: networkx[default] (>=3.0,<4.0)
Requires-Dist: plum-dispatch (>=2.1.1,<3.0.0)
Requires-Dist: rich (>=13,<14)
Requires-Dist: rtree (>=1.0.1,<2.0.0)
Requires-Dist: shapely (>=2.0.1,<3.0.0)
Requires-Dist: textual (>=0,<1) ; extra == "textual"
Project-URL: Repository, https://github.com/mahrz24/netext
Description-Content-Type: text/markdown

# netext

[![pypi](https://img.shields.io/pypi/v/netext.svg)](https://pypi.python.org/pypi/netext)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Version](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
[![Documentation](https://img.shields.io/badge/documentation-latest-green)](https://mahrz24.github.io/netext/)

![](logo.jpg)

Netext is a graph (network) rendering library for the terminal. It uses the awesome [rich](https://rich.readthedocs.io/en/stable/introduction.html) library to format output and can use different layout engines to place nodes and edges. The library has a very simple API that allows to render graphs created with networkx and integrates well with applications that use rich to output to the terminal. All styling and formatting is done via attributes the nodes and edges of the networkx graph data structures using special attributes keys.

![](example.svg)

The library is in its early stages and has currently no emphasis on performance, so please do not try to render large graphs with it. While it has been released expect some breaking API changes in the future. Node layout is currently provided by the [grandalf](https://github.com/bdcht/grandalf) library.

