Qt Dev Helper

PyPi Version Supported Python Versions Conda Version License

Actions Status Documentation Status codecov Documentation Coverage Ruff

All Contributors

Toolbox to help develop Qt applications, improving the usability of the existing tooling.

Installation

To install the CLI you can run one of the following commands (assuming you use pyside6 as Qt tooling suppliers):

uv pip install "qt-dev-helper[cli,pyside6]"

[!NOTE] While it is also possible to install qt-dev-helper globally with uv tool install "qt-dev-helper[cli,pyside6]" it is not recommend since it might cause version incompatibilities.

OR

pip install "qt-dev-helper[cli,pyside6]"

OR

conda install -c conda-forge qt-dev-helper

[!IMPORTANT] If you do not have the uic and rcc executables on your PATH, you still need to install the Qt tooling supplier with pip since there either is no conda version or conda version comes without tools (e.g. pyside6)

Features

  • Usable as Library and/or CLI tool

  • Compatible with PEP517 build system (see test case)

  • CLI auto completion

  • Project wide configuration in pyproject.toml

  • Recursive asset compiler for Qt projects (using uic and rcc):

    • *.ui -> *.py

    • *.qrc -> *.py

    • *.ui -> *.h

    • *.qrc -> *.h

    • *.scss -> *.qss

  • Support for multiple Qt tooling suppliers

    • PySide6-Essentials

    • qt6-applications

    • qt5-applications

  • Ability to open all *.ui files in a folder in QtDesigner

Planned features

  • Stand alone executable for each release (Windows)

  • File watch mode

  • qss injection into *.ui files

  • pre-commit hooks

FAQ

  • Q: Why is PyQt5 not supported?

    A: PyQt5 only ships a python specific version of uic and rcc breaking the tool API and compatibility with cpp projects. Use the matching version of qt5-applications as Qt tooling supplier.

  • Q: Error when using qt5-applications/qt6-applications?

    A: The distributions of qt5-applications and qt6-applications are using the pkg_resources module form setuptools which might not be installed and thus fail. Try installing setuptools e.g. pip install setuptools or conda install setuptools.

Contributors ✨

Thanks goes out to these wonderful people (emoji key):

Sebastian Weigand
Sebastian Weigand
💻 🤔 🚧 📆 🚇 ⚠️ 📖		 Joris Snellenburg
Joris Snellenburg
👀 🚧 🚇

This project follows the all-contributors specification. Contributions of any kind are welcome!