fxgui

Name	fxgui JSON
Version	4.5.1 JSON
	download
home_page	https://github.com/healkeiser/fxgui
Summary	Custom Python classes and utilities tailored for Qt built UI, in VFX-oriented DCC applications.
upload_time	2024-11-15 11:08:03
maintainer	None
docs_url	None
author	Valentin Beaumont
requires_python	None
license	MIT
keywords	qt pyside2 vfx dcc ui
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <div align="center">

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

  <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">&nbsp;&nbsp;
    <!-- <img src="https://img.shields.io/badge/maintenance-deprecated-red.svg?&label=Maintenance">&nbsp;&nbsp; -->
    <!-- License -->
    <img src="https://img.shields.io/badge/License-MIT-brightgreen.svg?&logo=open-source-initiative&logoColor=white" alt="License: MIT"/>&nbsp;&nbsp;
    <!-- PyPI -->
    <a href="https://pypi.org/project/fxgui">
      <img src="https://img.shields.io/pypi/v/fxgui?&logo=pypi&logoColor=white&label=PyPI" alt="PyPI version"/></a>&nbsp;&nbsp;
    <!-- PyPI downloads -->
    <a href="https://pepy.tech/project/fxgui">
      <img src="https://static.pepy.tech/badge/fxgui" alt="PyPI Downloads"></a>&nbsp;&nbsp;
    <!-- Last Commit -->
    <img src="https://img.shields.io/github/last-commit/healkeiser/fxgui?logo=github&label=Last%20Commit" alt="Last Commit"/>&nbsp;&nbsp;
    <!-- 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>&nbsp;&nbsp;
    <!-- GitHub stars -->
    <img src="https://img.shields.io/github/stars/healkeiser/fxgui" alt="GitHub Stars"/>&nbsp;&nbsp;
  </p>

</div>



<!-- TABLE OF CONTENTS -->
## Table of Contents

- [Table of Contents](#table-of-contents)
- [About](#about)
- [Installation](#installation)
- [Example](#example)
- [Documentation](#documentation)
- [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).

``` shell
pip install fxgui
```

> [!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/).



<!-- 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>&nbsp;&nbsp;
  <!-- 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>&nbsp;&nbsp;
  <!-- Behance -->
  <a href="https://www.behance.net/el1ven">
    <img src="https://img.shields.io/badge/el1ven-1769FF?logo=behance&style=social" alt="Behance"/></a>&nbsp;&nbsp;
  <!-- X -->
  <a href="https://twitter.com/valentinbeaumon">
    <img src="https://img.shields.io/badge/@valentinbeaumon-1DA1F2?logo=x&style=social" alt="Twitter"/></a>&nbsp;&nbsp;
  <!-- 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>&nbsp;&nbsp;
  <!-- Gumroad -->
  <a href="https://healkeiser.gumroad.com/subscribe">
    <img src="https://img.shields.io/badge/healkeiser-36a9ae?logo=gumroad&style=social" alt="Gumroad"/></a>&nbsp;&nbsp;
  <!-- 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>&nbsp;&nbsp;
  <!-- 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>&nbsp;&nbsp;
</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/1f/54/4b5e7d00da8c49c4e169a9de1bb82684d5ba82cbe9eaa2242d05e7d42024/fxgui-4.5.1.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n\n  ![Logo](https://raw.githubusercontent.com/healkeiser/fxgui/main/fxgui/images/fxgui_logo_background_dark.svg#gh-light-mode-only)\n  ![Logo](https://raw.githubusercontent.com/healkeiser/fxgui/main/fxgui/images/fxgui_logo_background_light.svg#gh-dark-mode-only)\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\">&nbsp;&nbsp;\n    <!-- <img src=\"https://img.shields.io/badge/maintenance-deprecated-red.svg?&label=Maintenance\">&nbsp;&nbsp; -->\n    <!-- License -->\n    <img src=\"https://img.shields.io/badge/License-MIT-brightgreen.svg?&logo=open-source-initiative&logoColor=white\" alt=\"License: MIT\"/>&nbsp;&nbsp;\n    <!-- PyPI -->\n    <a href=\"https://pypi.org/project/fxgui\">\n      <img src=\"https://img.shields.io/pypi/v/fxgui?&logo=pypi&logoColor=white&label=PyPI\" alt=\"PyPI version\"/></a>&nbsp;&nbsp;\n    <!-- PyPI downloads -->\n    <a href=\"https://pepy.tech/project/fxgui\">\n      <img src=\"https://static.pepy.tech/badge/fxgui\" alt=\"PyPI Downloads\"></a>&nbsp;&nbsp;\n    <!-- Last Commit -->\n    <img src=\"https://img.shields.io/github/last-commit/healkeiser/fxgui?logo=github&label=Last%20Commit\" alt=\"Last Commit\"/>&nbsp;&nbsp;\n    <!-- Commit Activity -->\n    <a href=\"https://github.com/healkeiser/fxgui/pulse\" alt=\"Activity\">\n      <img src=\"https://img.shields.io/github/commit-activity/m/healkeiser/fxgui?&logo=github&label=Commit%20Activity\"/></a>&nbsp;&nbsp;\n    <!-- GitHub stars -->\n    <img src=\"https://img.shields.io/github/stars/healkeiser/fxgui\" alt=\"GitHub Stars\"/>&nbsp;&nbsp;\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- [Contact](#contact)\n\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).\n\n``` shell\npip install fxgui\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<!-- 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>&nbsp;&nbsp;\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>&nbsp;&nbsp;\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>&nbsp;&nbsp;\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>&nbsp;&nbsp;\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>&nbsp;&nbsp;\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>&nbsp;&nbsp;\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>&nbsp;&nbsp;\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>&nbsp;&nbsp;\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": "4.5.1",
    "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": "6b37dee63641a3459bad73cec3cf969db2424b0915c37d9cf57383e9dc11262e",
                "md5": "3524f880a697cffdfce9b1e4b035fe5c",
                "sha256": "5311767b78e502604130c6f513710d2427f33a3916af7763e0fc031d582c0fd5"
            },
            "downloads": -1,
            "filename": "fxgui-4.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3524f880a697cffdfce9b1e4b035fe5c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 755460,
            "upload_time": "2024-11-15T11:08:01",
            "upload_time_iso_8601": "2024-11-15T11:08:01.123426Z",
            "url": "https://files.pythonhosted.org/packages/6b/37/dee63641a3459bad73cec3cf969db2424b0915c37d9cf57383e9dc11262e/fxgui-4.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1f544b5e7d00da8c49c4e169a9de1bb82684d5ba82cbe9eaa2242d05e7d42024",
                "md5": "0869ac762cdf5c286e6a41e6f8c761e8",
                "sha256": "096c7744e0ac91db7d6a5075fc8dee018904e95041ab17efddbe0a27e01b3ff9"
            },
            "downloads": -1,
            "filename": "fxgui-4.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0869ac762cdf5c286e6a41e6f8c761e8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 820396,
            "upload_time": "2024-11-15T11:08:03",
            "upload_time_iso_8601": "2024-11-15T11:08:03.145661Z",
            "url": "https://files.pythonhosted.org/packages/1f/54/4b5e7d00da8c49c4e169a9de1bb82684d5ba82cbe9eaa2242d05e7d42024/fxgui-4.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-15 11:08:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "healkeiser",
    "github_project": "fxgui",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "fxgui"
}