fxgui 11.3.0

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

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

From Source

Clone the repository with submodules:

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

Or using the requirements file:

pip install -r requirements.txt

Optional Dependencies

For building documentation with MkDocs:

pip install -e ".[mkdocs]"
# or
pip install -r requirements.mkdocs.txt

For building documentation with Zensical:

pip install -e ".[zensical]"
# or
pip install -r requirements.zensical.txt

[!NOTE] Zensical is still in early development and does not yet support all MkDocs plugins.

[!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, you can run the demo:

python examples.py

Or:

from fxgui import examples

examples.main()

Widget Examples

Each widget in the fxwidgets module includes a standalone example that can be run directly. Set the DEVELOPER_MODE environment variable to 1 to enable examples:

# Set the environment variable first
set DEVELOPER_MODE=1  # Windows
export DEVELOPER_MODE=1  # Linux/macOS

# Run any widget file directly to see its example
python -m fxgui.fxwidgets._breadcrumb
python -m fxgui.fxwidgets._accordion
python -m fxgui.fxwidgets._collapsible
# ... and more

Documentation

Please read the full documentation here.

Contact

Project Link: fxgui