https://github.com/healkeiser/fxgui

Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
https://github.com/healkeiser/fxgui

gui houdini maya nuke pyside2 python ui vfx vfx-pipeline

Last synced: 5 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/healkeiser/fxgui
Owner: healkeiser
License: mit
Created: 2023-08-22T17:35:38.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-12-15T17:45:54.000Z (over 1 year ago)
Last Synced: 2024-12-18T19:09:09.781Z (over 1 year ago)
Topics: gui, houdini, maya, nuke, pyside2, python, ui, vfx, vfx-pipeline
Language: Python
Homepage: https://healkeiser.github.io/fxgui/
Size: 9.7 MB
Stars: 17
Watchers: 3
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

![Logo](https://raw.githubusercontent.com/healkeiser/fxgui/main/fxgui/images/fxgui_logo_background_dark.svg#gh-light-mode-only)
![Logo](https://raw.githubusercontent.com/healkeiser/fxgui/main/fxgui/images/fxgui_logo_background_light.svg#gh-dark-mode-only)

fxgui

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

Documentation

GitHub Stars

## Table of Contents

- [Table of Contents](#table-of-contents)
- [About](#about)
- [Installation](#installation)
- [Example](#example)
- [Documentation](#documentation)
- [Screenshots](#screenshots)
- [Contact](#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](https://pypi.org/project/fxgui):

``` shell
pip install fxgui
```

### From Source

Clone the repository with submodules:

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

Or using the requirements file:

``` shell
pip install -r requirements.txt
```

### Optional Dependencies

For building documentation with MkDocs:

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

For building documentation with Zensical:

``` shell
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](./houdini_package.json).

## Example

After installing fxgui, you can run the demo:

``` shell
python examples.py
```

Or:

``` python
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:

``` shell
# 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](https://healkeiser.github.io/fxgui/).

## Contact

Project Link: [fxgui](https://github.com/healkeiser/fxgui)