joaonc / show_dialog

Easily show a dialog for miscellaneous uses.
https://joaonc.github.io/show_dialog
MIT License
0 stars 0 forks source link
python qt

qt-show-dialog

pypi Project License - MIT

Easily show a dialog window for miscellaneous purposes (features).


The initial use case is to show instructions in manual steps in tests.

Uses Qt 6 and Qt for Python, aka PySide, which includes Qt Designer, a WYSIWYG UI editor.

Getting started

Documentation: https://joaonc.github.io/show_dialog

Installation

pip install qt-show-dialog

It can be used as a package or in the CLI with the show_dialog command.

Can also be used as an executable app with no dependencies (ie, no need for Python or a virtual environment).

Example

show dialog

Inputs that generated the dialog 👆

dialog_title: Manual step
title: Disconnect cable
description: |
    In this step we need to disconnect the power cable  
    and verify that the reserve battery gets discharged  
    within 5 seconds.

    ## Steps
    1. Disconnect power cable.  
       It's in the back.
    2. Wait 5 seconds.
    3. Check that reserve battery is empty.  
       See below for more info.

    ## Verifying battery is discharged
    There's a red light that goes off.

    **Do not touch** the button next to that light.

    More info on that light [here](#some-path).
description_md: true
timeout: 20

More info in documentation here.