Metadata-Version: 2.4
Name: pyed
Version: 1.2.5
Summary: Python Yed Simple Graph generator
Author-email: Christophe Cossou <ccossou@gmail.com>
License: MIT License
        Copyright (c) 2020 Christophe Cossou
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: homepage, https://github.com/ccossou/Pyed
Project-URL: documentation, https://pyed.readthedocs.io
Project-URL: source, https://github.com/ccossou/Pyed
Project-URL: tracker, https://github.com/ccossou/Pyed/issues
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pytest
Requires-Dist: setuptools
Requires-Dist: pyyaml
Dynamic: license-file

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

Pyed provide a set of tools to create a graphML instance from Python. For simple graph you can also use a .yaml file for convenience

- **Documentation:** https://pyed.readthedocs.io/en/latest/
- **Source code:** https://github.com/ccossou/Pyed
- **Bug reports:** https://github.com/ccossou/Pyed/issues


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?

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)

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.
