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
Metadata
1 maintainer
Release files for fxgui 12.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fxgui-12.6.0.tar.gz | 5.0 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fxgui-12.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.7 MB
Release files / fxgui-12.6.0.tar.gz
| Download URL | fxgui-12.6.0.tar.gz |
|---|---|
| Size | 5.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9a94d7f0676f429b51c03e3f8f015a0757076c38dc3791cb84f20f45082466c3
|
|
BLAKE2b-256 checksum How to use checksums |
da3059ea211a07e5651ce654e225e6e6041dbf76090f3e228bb336ea28dd7635
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Release files / fxgui-12.6.0-py3-none-any.whl
| Download URL | fxgui-12.6.0-py3-none-any.whl |
|---|---|
| Size | 10.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
13c73e2a825536a7f8cebe5a62d18071fbb31d5580df020e87f929309f5d3ca3
|
|
BLAKE2b-256 checksum How to use checksums |
90c665c6e5eb449b5000fae52793d1b0a7515c797b82c5f802a922f25b790dda
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
