fxgui

Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.

Documentation

                       

Table of Contents

• Table of Contents
• About
• Installation
• Example
• Documentation
• Screenshots
• Contact

About

Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.

Installation

From PyPI

The package is available on PyPI:

pip install fxgui

Qt Binding

A Qt 6 binding is required and not installed with fxgui: PySide6 6.5 or newer, or PyQt6. A DCC such as Houdini ships its own PySide6; outside one, install it yourself:

pip install fxgui "PySide6>=6.5"

Qt 5 (PySide2, PyQt5) is not supported: import fxgui raises an ImportError that names the binding it found.

From Source

Clone the repository:

git clone https://github.com/healkeiser/fxgui
cd fxgui
pip install -e .

Or using the requirements file:

pip install -r requirements.txt

Optional Dependencies

To build the documentation site with Zensical:

pip install -e ".[zensical]"
zensical serve    # Preview at http://127.0.0.1:8000
zensical build    # Write the site to site/

Important

In order to have access to the module inside your application, make sure to add fxgui to the $PYTHONPATH of the DCCs. For Houdini, you can find the houdini_package.json example file.

Example

After installing fxgui, open the gallery. It shows every public widget, a page per kind, and its Window menu switches the theme:

python -m fxgui.examples

Documentation

Please read the full documentation here.

Contact

Project Link: fxgui