Metadata-Version: 2.1
Name: pyed
Version: 1.1.0
Summary: "Python Yed Simple Graph generator"
Home-page: https://github.com/ccossou/Pyed
Author: "Christophe Cossou"
Author-email: "ccossou@gmail.com"
Platform: ["Linux"
Platform: "Mac OS X"]
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pytest
Requires-Dist: setuptools

# Pyed
This package is yet another tool to help generate graph using Python + [Yed](https://www.yworks.com/products/yed).

Other packages that exists (that took the best names):
* [Pyyed](https://github.com/jamesscottbrown/pyyed) (My package is loosely based on this one)
* [Pygraphml](https://github.com/hadim/pygraphml)
* [NetworkX](https://networkx.org/documentation/stable/reference/readwrite/graphml.html)

My package focus on drawing simple graph to quickly visualise relations between informations. It's a crude subset of what graphs are capable of. My intent is to have a kind of [Inkscape](https://inkscape.org/release), but for graph. [Yed](https://www.yworks.com/products/yed) is that, but I don't want to add and draw manually dozen of nodes when trying to understand a datastructure or a code.

These pages are thought to provide quick documentation on what you can do with this package, especially the different types of nodes and the parameter and values available.

### Why another package?
I wanted functionalities that do not exist in those packages. I wanted a way to create package with enhanced data visualisation, in particular node with list of information (GenericNode in Pyed) and node with table of data (TableNode in Pyed) and custom nodes with any .svg file as a shape (SvgNode in Pyed).

### Principle
This package will not create finalized graph on its own. You'll have to use [Yed](https://www.yworks.com/products/yed) or another GUI that support .graphml to render the graph correctly. By default, node size is not adapted to its content, and all nodes are on top of eachother.
