Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
Documentation
Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
The package is available on PyPI:
pip install fxguiClone 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.txtFor building documentation with MkDocs:
pip install -e ".[mkdocs]"
# or
pip install -r requirements.mkdocs.txtFor building documentation with Zensical:
pip install -e ".[zensical]"
# or
pip install -r requirements.zensical.txtNote
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.
After installing fxgui, you can run the demo:
python examples.pyOr:
from fxgui import examples
examples.main()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 morePlease read the full documentation here.
Project Link: fxgui
