Home

Welcome to the Utilities wiki!

These pages are intended to give a more detailed view of the project. Each module's description will also contain a version ID so that one can see if the wiki is in sync with the code.

Getting started

To install the package via pip:

pip install utils-qt-mk

When starting a new project, you need to configure the package. Related functions can be found in the config module. As an example, you need to set a path to your theme file if you want to use modules that depend on themes, like so:

from utils_qt_mk.config import set_theme_dir, set_cfd_data_file_path

set_theme_dir(os.path.join(os.getcwd(), 'src', 'themes'))
set_cfd_data_file_path(os.path.join(os.getcwd(), 'src', 'JSONs', 'custom_file_dialog_data.json'))

Here I also set a path to a specific, "external" custom file dialog (cfd) file to use instead of the one in the project. This makes it easier to edit the file manually and a built application can keep modifying it (updating the last selected path).

If you already have a file containing custom messagebox data that you wish to use in the project, you can do

from utils_qt_mk.message import merge_json as merge_json_msg

merge_json_msg(r'C:\Path\to\your\fi.le')

You can usually find an example usage of the widgets defined in the module at the module's bottom in the form of a _TestApplication class which can be run by running the module itself.