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: about 1 month 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 (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-15T17:45:54.000Z (about 1 month ago)
• Last Synced: 2024-12-18T19:09:09.781Z (about 1 month 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

  


  ##

  


    

       

    

    

       

    

       

    

    

         

    

    

         

    

       

    

    

         

    

       

  

      



## 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

The package is available on [PyPI](https://pypi.org/project/fxgui) and can be installed via `pip`:

``` shell

python -m pip install fxgui

```

The repository contains submodules, so make sure to clone the repository with the `--recurse-submodules` flag:

``` shell

git clone --recurse-submodules https://github.com/healkeiser/fxgui

```

Or, if you already cloned the repository, you can initialize the submodules with:

``` shell

git submodule update --init --recursive

```

> [!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()

```

## Documentation

Please read the full documentation [here](https://healkeiser.github.io/fxgui/).

## Screenshots



  

  

  

  



## Contact

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