<div align="center">
<h3 align="center">fxgui</h3>
<p align="center">
Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
<br/><br/>
<a href="https://healkeiser.github.io/fxgui"><strong>Documentation</strong></a>
</p>
##
<p align="center">
<!-- Maintenance status -->
<img src="https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg?&label=Maintenance">
<!-- <img src="https://img.shields.io/badge/maintenance-deprecated-red.svg?&label=Maintenance"> -->
<!-- License -->
<img src="https://img.shields.io/github/license/healkeiser/fxgui?&label=License"/>
<!-- GitHub build workflow -->
<img src="https://img.shields.io/github/actions/workflow/status/healkeiser/fxgui/python-publish.yml?&label=Build&logo=pypi&logoColor=white" alt="Build">
<!-- PyPI version-->
<a href="https://pypi.org/project/fxgui"><img src="https://img.shields.io/pypi/v/fxgui?&logo=pypi&logoColor=white&label=Version" alt="PyPI Version"/></a>
<!-- PyPI downloads -->
<a href="https://pepy.tech/projects/fxgui"><img src="https://static.pepy.tech/badge/fxgui" alt="PyPI Downloads"></a>
<!-- Last Commit -->
<img src="https://img.shields.io/github/last-commit/healkeiser/fxgui?logo=github&label=Last%20Commit" alt="Last Commit">
<!-- Commit Activity -->
<a href="https://github.com/healkeiser/fxgui/pulse" alt="Activity"><img src="https://img.shields.io/github/commit-activity/m/healkeiser/fxgui?&logo=github&label=Commit%20Activity"></a>
<!-- GitHub stars -->
<img src="https://img.shields.io/github/stars/healkeiser/fxgui" alt="GitHub Stars"/>
</p>
</div>
<!-- TABLE OF CONTENTS -->
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About](#about)
- [Installation](#installation)
- [Example](#example)
- [Documentation](#documentation)
- [Screenshots](#screenshots)
- [Contact](#contact)
<!-- ABOUT -->
## About
Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
<!-- INSTALLATION -->
## 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 -->
## Example
After installing fxgui, you can run the demo:
``` shell
python examples.py
```
Or:
``` python
from fxgui import examples
examples.main()
```
<!-- DOCUMENTATION -->
## Documentation
Please read the full documentation [here](https://healkeiser.github.io/fxgui/).
<!-- SCREENSHOTS -->
## Screenshots
<p align="center">
<img width="500" src="docs/images/python_yFzxAPqS13.png">
<img width="500" src="docs/images/python_x9pbgeXwaT.png">
<img width="500" src="docs/images/python_8O8aQuwsy8.png">
<img width="500" src="docs/images/python_EM6S9rdJYw.png">
</p>
<!-- CONTACT -->
## Contact
Project Link: [fxgui](https://github.com/healkeiser/fxgui)
<p align='center'>
<!-- GitHub profile -->
<a href="https://github.com/healkeiser">
<img src="https://img.shields.io/badge/healkeiser-181717?logo=github&style=social" alt="GitHub"/></a>
<!-- LinkedIn -->
<a href="https://www.linkedin.com/in/valentin-beaumont">
<img src="https://img.shields.io/badge/Valentin%20Beaumont-0A66C2?logo=linkedin&style=social" alt="LinkedIn"/></a>
<!-- Behance -->
<a href="https://www.behance.net/el1ven">
<img src="https://img.shields.io/badge/el1ven-1769FF?logo=behance&style=social" alt="Behance"/></a>
<!-- X -->
<a href="https://twitter.com/valentinbeaumon">
<img src="https://img.shields.io/badge/@valentinbeaumon-1DA1F2?logo=x&style=social" alt="Twitter"/></a>
<!-- Instagram -->
<a href="https://www.instagram.com/val.beaumontart">
<img src="https://img.shields.io/badge/@val.beaumontart-E4405F?logo=instagram&style=social" alt="Instagram"/></a>
<!-- Gumroad -->
<a href="https://healkeiser.gumroad.com/subscribe">
<img src="https://img.shields.io/badge/healkeiser-36a9ae?logo=gumroad&style=social" alt="Gumroad"/></a>
<!-- Gmail -->
<a href="mailto:valentin.onze@gmail.com">
<img src="https://img.shields.io/badge/valentin.onze@gmail.com-D14836?logo=gmail&style=social" alt="Email"/></a>
<!-- Buy me a coffee -->
<a href="https://www.buymeacoffee.com/healkeiser">
<img src="https://img.shields.io/badge/Buy Me A Coffee-FFDD00?&logo=buy-me-a-coffee&logoColor=black" alt="Buy Me A Coffee"/></a>
</p>
Raw data
{
"_id": null,
"home_page": "https://github.com/healkeiser/fxgui",
"name": "fxgui",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Qt PySide2 VFX DCC UI",
"author": "Valentin Beaumont",
"author_email": "valentin.onze@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/04/0e/a25041767b6bfccc4870caa6c58370fced7bdced380d2850db063d927122/fxgui-6.5.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n \n \n\n <h3 align=\"center\">fxgui</h3>\n\n <p align=\"center\">\n Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.\n <br/><br/>\n <a href=\"https://healkeiser.github.io/fxgui\"><strong>Documentation</strong></a>\n </p>\n\n ##\n\n <p align=\"center\">\n <!-- Maintenance status -->\n <img src=\"https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg?&label=Maintenance\"> \n <!-- <img src=\"https://img.shields.io/badge/maintenance-deprecated-red.svg?&label=Maintenance\"> -->\n <!-- License -->\n <img src=\"https://img.shields.io/github/license/healkeiser/fxgui?&label=License\"/> \n <!-- GitHub build workflow -->\n <img src=\"https://img.shields.io/github/actions/workflow/status/healkeiser/fxgui/python-publish.yml?&label=Build&logo=pypi&logoColor=white\" alt=\"Build\"> \n <!-- PyPI version-->\n <a href=\"https://pypi.org/project/fxgui\"><img src=\"https://img.shields.io/pypi/v/fxgui?&logo=pypi&logoColor=white&label=Version\" alt=\"PyPI Version\"/></a> \n <!-- PyPI downloads -->\n <a href=\"https://pepy.tech/projects/fxgui\"><img src=\"https://static.pepy.tech/badge/fxgui\" alt=\"PyPI Downloads\"></a> \n <!-- Last Commit -->\n <img src=\"https://img.shields.io/github/last-commit/healkeiser/fxgui?logo=github&label=Last%20Commit\" alt=\"Last Commit\"> \n <!-- Commit Activity -->\n <a href=\"https://github.com/healkeiser/fxgui/pulse\" alt=\"Activity\"><img src=\"https://img.shields.io/github/commit-activity/m/healkeiser/fxgui?&logo=github&label=Commit%20Activity\"></a> \n <!-- GitHub stars -->\n <img src=\"https://img.shields.io/github/stars/healkeiser/fxgui\" alt=\"GitHub Stars\"/> \n </p>\n \n</div>\n\n\n\n<!-- TABLE OF CONTENTS -->\n## Table of Contents\n\n- [Table of Contents](#table-of-contents)\n- [About](#about)\n- [Installation](#installation)\n- [Example](#example)\n- [Documentation](#documentation)\n- [Screenshots](#screenshots)\n- [Contact](#contact)\n\n\n\n<!-- ABOUT -->\n## About\n\nCustom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.\n\n\n\n<!-- INSTALLATION -->\n## Installation\n\nThe package is available on [PyPI](https://pypi.org/project/fxgui) and can be installed via `pip`:\n\n\n``` shell\npython -m pip install fxgui\n```\n\nThe repository contains submodules, so make sure to clone the repository with the `--recurse-submodules` flag:\n\n``` shell\ngit clone --recurse-submodules https://github.com/healkeiser/fxgui\n```\n\nOr, if you already cloned the repository, you can initialize the submodules with:\n\n``` shell\ngit submodule update --init --recursive\n```\n\n> [!IMPORTANT]\n> 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).\n\n\n\n<!-- EXAMPLE -->\n## Example\n\nAfter installing fxgui, you can run the demo:\n\n``` shell\npython examples.py\n```\n\nOr:\n\n``` python\nfrom fxgui import examples\n\nexamples.main()\n```\n\n\n\n<!-- DOCUMENTATION -->\n## Documentation\n\nPlease read the full documentation [here](https://healkeiser.github.io/fxgui/).\n\n\n\n<!-- SCREENSHOTS -->\n## Screenshots\n<p align=\"center\">\n <img width=\"500\" src=\"docs/images/python_yFzxAPqS13.png\">\n <img width=\"500\" src=\"docs/images/python_x9pbgeXwaT.png\">\n <img width=\"500\" src=\"docs/images/python_8O8aQuwsy8.png\">\n <img width=\"500\" src=\"docs/images/python_EM6S9rdJYw.png\">\n</p>\n\n\n\n<!-- CONTACT -->\n## Contact\n\nProject Link: [fxgui](https://github.com/healkeiser/fxgui)\n\n<p align='center'>\n <!-- GitHub profile -->\n <a href=\"https://github.com/healkeiser\">\n <img src=\"https://img.shields.io/badge/healkeiser-181717?logo=github&style=social\" alt=\"GitHub\"/></a> \n <!-- LinkedIn -->\n <a href=\"https://www.linkedin.com/in/valentin-beaumont\">\n <img src=\"https://img.shields.io/badge/Valentin%20Beaumont-0A66C2?logo=linkedin&style=social\" alt=\"LinkedIn\"/></a> \n <!-- Behance -->\n <a href=\"https://www.behance.net/el1ven\">\n <img src=\"https://img.shields.io/badge/el1ven-1769FF?logo=behance&style=social\" alt=\"Behance\"/></a> \n <!-- X -->\n <a href=\"https://twitter.com/valentinbeaumon\">\n <img src=\"https://img.shields.io/badge/@valentinbeaumon-1DA1F2?logo=x&style=social\" alt=\"Twitter\"/></a> \n <!-- Instagram -->\n <a href=\"https://www.instagram.com/val.beaumontart\">\n <img src=\"https://img.shields.io/badge/@val.beaumontart-E4405F?logo=instagram&style=social\" alt=\"Instagram\"/></a> \n <!-- Gumroad -->\n <a href=\"https://healkeiser.gumroad.com/subscribe\">\n <img src=\"https://img.shields.io/badge/healkeiser-36a9ae?logo=gumroad&style=social\" alt=\"Gumroad\"/></a> \n <!-- Gmail -->\n <a href=\"mailto:valentin.onze@gmail.com\">\n <img src=\"https://img.shields.io/badge/valentin.onze@gmail.com-D14836?logo=gmail&style=social\" alt=\"Email\"/></a> \n <!-- Buy me a coffee -->\n <a href=\"https://www.buymeacoffee.com/healkeiser\">\n <img src=\"https://img.shields.io/badge/Buy Me A Coffee-FFDD00?&logo=buy-me-a-coffee&logoColor=black\" alt=\"Buy Me A Coffee\"/></a> \n</p>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.",
"version": "6.5.0",
"project_urls": {
"Changelog": "https://github.com/healkeiser/fxgui/blob/main/CHANGELOG.md",
"Documentation": "https://healkeiser.github.io/fxgui",
"Funding": "https://github.com/sponsors/healkeiser",
"GitHub": "https://github.com/healkeiser/fxgui",
"Homepage": "https://github.com/healkeiser/fxgui",
"Source": "https://github.com/healkeiser/fxgui"
},
"split_keywords": [
"qt",
"pyside2",
"vfx",
"dcc",
"ui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38f932329873fe52b34d1cb63299a864f948f24f3b0caa039ae2cde423e67b10",
"md5": "7af01c60e0f1a30c4ced414c592fab18",
"sha256": "7d7240156bfa30e10cf1ba05e8cc8675396c30d378112d3eb23bb917ef0b3a34"
},
"downloads": -1,
"filename": "fxgui-6.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7af01c60e0f1a30c4ced414c592fab18",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 27794180,
"upload_time": "2025-01-06T20:10:20",
"upload_time_iso_8601": "2025-01-06T20:10:20.160718Z",
"url": "https://files.pythonhosted.org/packages/38/f9/32329873fe52b34d1cb63299a864f948f24f3b0caa039ae2cde423e67b10/fxgui-6.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "040ea25041767b6bfccc4870caa6c58370fced7bdced380d2850db063d927122",
"md5": "9dc9c3a7766afe43361b246dc6c73601",
"sha256": "9f6185155f9b30a66d28a26bbde75b99d9c69ecbf30d990f1e0cab1bae9e6eb1"
},
"downloads": -1,
"filename": "fxgui-6.5.0.tar.gz",
"has_sig": false,
"md5_digest": "9dc9c3a7766afe43361b246dc6c73601",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18817840,
"upload_time": "2025-01-06T20:10:26",
"upload_time_iso_8601": "2025-01-06T20:10:26.548979Z",
"url": "https://files.pythonhosted.org/packages/04/0e/a25041767b6bfccc4870caa6c58370fced7bdced380d2850db063d927122/fxgui-6.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 20:10:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "healkeiser",
"github_project": "fxgui",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "QtPy",
"specs": [
[
">=",
"2.4.2"
]
]
},
{
"name": "QtAwesome",
"specs": [
[
">=",
"1.3.1"
]
]
}
],
"lcname": "fxgui"
}
JSON
