Metadata-Version: 2.1
Name: NodeGraphQt
Version: 0.6.35
Summary: Node graph framework for PySide2/PyQt5 that can be
Home-page: https://github.com/jchanvfx/NodeGraphQt
Author: Johnny Chan
License: MIT License
Project-URL: Documentation, https://jchanvfx.github.io/NodeGraphQt/api/index.html
Project-URL: Source, https://github.com/jchanvfx/NodeGraphQt/
Project-URL: Tracker, https://github.com/jchanvfx/NodeGraphQt/issues
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: Qt.py>=1.2.0
Provides-Extra: pyside2
Requires-Dist: PySide2>=5.15; extra == "pyside2"


# NodeGraphQt

[![API Documentation](https://github.com/jchanvfx/NodeGraphQt/actions/workflows/sphinx_doc_build.yml/badge.svg)](https://github.com/jchanvfx/NodeGraphQt/actions/workflows/sphinx_doc_build.yml)
[![PyPI Package](https://github.com/jchanvfx/NodeGraphQt/actions/workflows/pypi_publish.yml/badge.svg)](https://github.com/jchanvfx/NodeGraphQt/actions/workflows/pypi_publish.yml)
![GitHub Repo stars](https://img.shields.io/github/stars/jchanvfx/NodeGraphQt?style=social)

<p align="center">
    <a href="https://jchanvfx.github.io/NodeGraphQt" target="_blank">
    <img src="https://raw.githubusercontent.com/jchanvfx/NodeGraphQt/main/docs/_images/logo.png" title="logo">
    </a>
</p>

NodeGraphQt is a node graph UI framework for `PySide2` that can be implemented and re-purposed into 
applications.

<img src="https://raw.githubusercontent.com/jchanvfx/NodeGraphQt/main/docs/_images/screenshot.png" width="100%" title="NodeGraphQt">

## Install

NodeGraphQt is available on The Python Package Index (PyPI) [here](https://pypi.org/project/NodeGraphQt) so it can be installed with:
```
pip install NodeGraphQt
```
or you can download previous versions from the [releases](https://github.com/jchanvfx/NodeGraphQt/releases) page.


## Documentation

<a href="https://jchanvfx.github.io/NodeGraphQt" target="_blank">https://jchanvfx.github.io/NodeGraphQt</a>

See the [basic_example.py](/examples/basic_example.py) script to get started or check out the API example overview 
<a href="https://jchanvfx.github.io/NodeGraphQt/api/examples/ex_overview.html#simple-example" target="_blank">here.</a>

## Vertical Layout

https://jchanvfx.github.io/NodeGraphQt/api/examples/ex_pipe.html#layout-direction

<img src="https://raw.githubusercontent.com/jchanvfx/NodeGraphQt/main/docs/_images/vertical_layout.png" width="800" title="Vertical Layout">

## Pipe Layout

https://jchanvfx.github.io/NodeGraphQt/api/examples/ex_pipe.html#layout-styles

<img src="https://raw.githubusercontent.com/jchanvfx/NodeGraphQt/main/docs/_images/pipe_layout_types.gif" width="600" title="Pipe Layout">

## Custom Widgets

https://jchanvfx.github.io/NodeGraphQt/api/custom_widgets.html

<img src="https://raw.githubusercontent.com/jchanvfx/NodeGraphQt/main/docs/_images/prop_bin.png" width="600" title="Properties Bin">

<img src="https://raw.githubusercontent.com/jchanvfx/NodeGraphQt/main/docs/_images/nodes_palette.png" width="450" title="Node Palette">
