fxgui
Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
Documentation
Table of Contents
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
fxguito the$PYTHONPATHof the DCCs. For Houdini, you can find thehoudini_package.jsonexample 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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fxgui-12.3.0.tar.gz.
File metadata
- Download URL: fxgui-12.3.0.tar.gz
- Upload date:
- Size: 5.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6af3784dfbf1fa0747984344b5176760d64b40fde80220930027743a71e24c01
|
|
| MD5 |
3003a64b73b435864ce2124a41e876d1
|
|
| BLAKE2b-256 |
ffda3619bbd2a67c6ec143fc0926865dffbdebf8e5c6ece2729f8f6edd99f1a9
|
File details
Details for the file fxgui-12.3.0-py3-none-any.whl.
File metadata
- Download URL: fxgui-12.3.0-py3-none-any.whl
- Upload date:
- Size: 10.7 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a3159a8e4af2ab97bfef1b4b2251ffe28bdb820dd7a0745d987cdf2aa68fce9f
|
|
| MD5 |
ea3b250cec58bc48b8aadbc4c8dbba50
|
|
| BLAKE2b-256 |
e2aea901fe72d7d202a80df8edb04f9a0f9fecd92f7d3976a0222b5d298f2156
|
