qt-show-dialog


Nameqt-show-dialog JSON
Version 0.9.1 PyPI version JSON
download
home_pageNone
SummaryEasily show a dialog window for miscellaneous purposes.
upload_time2025-10-10 18:33:33
maintainerNone
docs_urlNone
authorJoao Coelho
requires_python>=3.10
licenseNone
keywords python qt qt6 testing manual
VCS
bugtrack_url
requirements markdown mashumaro packaging pyside6 pyside6-addons pyside6-essentials pyyaml qdarkstyle qtpy shiboken6 typing-extensions
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # qt-show-dialog

[![pypi](https://img.shields.io/pypi/v/qt-show-dialog.svg)](https://pypi.python.org/pypi/qt-show-dialog)
[![Project License - MIT](https://img.shields.io/pypi/l/qt-show-dialog.svg)](https://github.com/joaonc/show_dialog/blob/main/LICENSE.txt)

Easily show a dialog window for miscellaneous purposes
([features](https://joaonc.github.io/show_dialog/#features)).

----

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

Uses [Qt 6](https://www.qt.io) and [Qt for Python](https://wiki.qt.io/Qt_for_Python), aka _PySide_,
which includes _Qt Designer_, a WYSIWYG UI editor.

## Getting started
Documentation: [https://joaonc.github.io/show_dialog](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](https://joaonc.github.io/show_dialog/#executable-app) with
no dependencies (ie, no need for Python or a virtual environment).

### Example
[![show dialog](https://raw.githubusercontent.com/joaonc/show_dialog/main/docs/images/show_dialog_example.png)](https://joaonc.github.io/show_dialog/#example)

Inputs that generated the dialog 👆
```yaml
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](https://joaonc.github.io/show_dialog/#example).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "qt-show-dialog",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "python, qt, qt6, testing, manual",
    "author": "Joao Coelho",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/ac/94/383710b31ee7abc5466a7b8cd53664ec2f212517b8693b0b8ade0556276d/qt_show_dialog-0.9.1.tar.gz",
    "platform": null,
    "description": "# qt-show-dialog\n\n[![pypi](https://img.shields.io/pypi/v/qt-show-dialog.svg)](https://pypi.python.org/pypi/qt-show-dialog)\n[![Project License - MIT](https://img.shields.io/pypi/l/qt-show-dialog.svg)](https://github.com/joaonc/show_dialog/blob/main/LICENSE.txt)\n\nEasily show a dialog window for miscellaneous purposes\n([features](https://joaonc.github.io/show_dialog/#features)).\n\n----\n\nThe initial use case is to show instructions in manual steps in tests.\n\nUses [Qt 6](https://www.qt.io) and [Qt for Python](https://wiki.qt.io/Qt_for_Python), aka _PySide_,\nwhich includes _Qt Designer_, a WYSIWYG UI editor.\n\n## Getting started\nDocumentation: [https://joaonc.github.io/show_dialog](https://joaonc.github.io/show_dialog/)\n\n### Installation\n```\npip install qt-show-dialog\n```\n\nIt can be used as a package or in the CLI with the `show_dialog` command.\n\nCan also be used as an [executable app](https://joaonc.github.io/show_dialog/#executable-app) with\nno dependencies (ie, no need for Python or a virtual environment).\n\n### Example\n[![show dialog](https://raw.githubusercontent.com/joaonc/show_dialog/main/docs/images/show_dialog_example.png)](https://joaonc.github.io/show_dialog/#example)\n\nInputs that generated the dialog \ud83d\udc46\n```yaml\ndialog_title: Manual step\ntitle: Disconnect cable\ndescription: |\n    In this step we need to disconnect the power cable  \n    and verify that the reserve battery gets discharged  \n    within 5 seconds.\n    \n    ## Steps\n    1. Disconnect power cable.  \n       It's in the back.\n    2. Wait 5 seconds.\n    3. Check that reserve battery is empty.  \n       See below for more info.\n\n    ## Verifying battery is discharged\n    There's a red light that goes off.\n    \n    **Do not touch** the button next to that light.\n    \n    More info on that light [here](#some-path).\ndescription_md: true\ntimeout: 20\n```\nMore info in documentation [here](https://joaonc.github.io/show_dialog/#example).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Easily show a dialog window for miscellaneous purposes.",
    "version": "0.9.1",
    "project_urls": {
        "Documentation": "https://joaonc.github.io/show_dialog",
        "Home": "https://github.com/joaonc/show_dialog"
    },
    "split_keywords": [
        "python",
        " qt",
        " qt6",
        " testing",
        " manual"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "60f2c7721a1734993ea311b4379e5465811dd8b45523f8490c6d691f96a87beb",
                "md5": "b362251a710493b09f10a427159601f4",
                "sha256": "3ff94d6712a889c1bf61b1ebc592251b37f2656367b5272fc855cf2a9c79126e"
            },
            "downloads": -1,
            "filename": "qt_show_dialog-0.9.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b362251a710493b09f10a427159601f4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 65625,
            "upload_time": "2025-10-10T18:33:31",
            "upload_time_iso_8601": "2025-10-10T18:33:31.702197Z",
            "url": "https://files.pythonhosted.org/packages/60/f2/c7721a1734993ea311b4379e5465811dd8b45523f8490c6d691f96a87beb/qt_show_dialog-0.9.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ac94383710b31ee7abc5466a7b8cd53664ec2f212517b8693b0b8ade0556276d",
                "md5": "a547807bd74c9391e63ed51fcc5a931c",
                "sha256": "fd3a61c3ce9703bfd3ac388029ce55ee5087a4f0ee334119139e5497764092d0"
            },
            "downloads": -1,
            "filename": "qt_show_dialog-0.9.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a547807bd74c9391e63ed51fcc5a931c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 465449,
            "upload_time": "2025-10-10T18:33:33",
            "upload_time_iso_8601": "2025-10-10T18:33:33.173564Z",
            "url": "https://files.pythonhosted.org/packages/ac/94/383710b31ee7abc5466a7b8cd53664ec2f212517b8693b0b8ade0556276d/qt_show_dialog-0.9.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-10 18:33:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "joaonc",
    "github_project": "show_dialog",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "markdown",
            "specs": [
                [
                    "==",
                    "3.9"
                ]
            ]
        },
        {
            "name": "mashumaro",
            "specs": [
                [
                    "==",
                    "3.17"
                ]
            ]
        },
        {
            "name": "packaging",
            "specs": [
                [
                    "==",
                    "25.0"
                ]
            ]
        },
        {
            "name": "pyside6",
            "specs": [
                [
                    "==",
                    "6.10.0"
                ]
            ]
        },
        {
            "name": "pyside6-addons",
            "specs": [
                [
                    "==",
                    "6.10.0"
                ]
            ]
        },
        {
            "name": "pyside6-essentials",
            "specs": [
                [
                    "==",
                    "6.10.0"
                ]
            ]
        },
        {
            "name": "pyyaml",
            "specs": [
                [
                    "==",
                    "6.0.3"
                ]
            ]
        },
        {
            "name": "qdarkstyle",
            "specs": [
                [
                    "==",
                    "3.2.3"
                ]
            ]
        },
        {
            "name": "qtpy",
            "specs": [
                [
                    "==",
                    "2.4.3"
                ]
            ]
        },
        {
            "name": "shiboken6",
            "specs": [
                [
                    "==",
                    "6.10.0"
                ]
            ]
        },
        {
            "name": "typing-extensions",
            "specs": [
                [
                    "==",
                    "4.15.0"
                ]
            ]
        }
    ],
    "lcname": "qt-show-dialog"
}
        
Elapsed time: 5.02719s