# qt-show-dialog
[](https://pypi.python.org/pypi/qt-show-dialog)
[](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
[](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/bc/8a/d92ab26bf5e33f2dbddbcbef49e46329759195783261fc65ff59d05b0ef3/qt_show_dialog-0.8.1.tar.gz",
"platform": null,
"description": "# qt-show-dialog\n\n[](https://pypi.python.org/pypi/qt-show-dialog)\n[](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[](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.8.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": "282d37629d9ce165292d8479d806423206dbed6a8eafe0940948d3a8c6c9266b",
"md5": "74c3c3cd269ef1ea1da874017a5dde6b",
"sha256": "ff708d20b6c8d0d07f11088291e112bbd70479869823f585257a7991d492c8d0"
},
"downloads": -1,
"filename": "qt_show_dialog-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "74c3c3cd269ef1ea1da874017a5dde6b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 59421,
"upload_time": "2024-08-28T17:12:58",
"upload_time_iso_8601": "2024-08-28T17:12:58.389122Z",
"url": "https://files.pythonhosted.org/packages/28/2d/37629d9ce165292d8479d806423206dbed6a8eafe0940948d3a8c6c9266b/qt_show_dialog-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bc8ad92ab26bf5e33f2dbddbcbef49e46329759195783261fc65ff59d05b0ef3",
"md5": "b94f31c024f8655ae347853a738d38c0",
"sha256": "cb0e58cb60d54e508b44df3424121c81f6dc4824ead7c7cc6d9cbf74f0d3e061"
},
"downloads": -1,
"filename": "qt_show_dialog-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "b94f31c024f8655ae347853a738d38c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 458376,
"upload_time": "2024-08-28T17:12:59",
"upload_time_iso_8601": "2024-08-28T17:12:59.862258Z",
"url": "https://files.pythonhosted.org/packages/bc/8a/d92ab26bf5e33f2dbddbcbef49e46329759195783261fc65ff59d05b0ef3/qt_show_dialog-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 17:12:59",
"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.7"
]
]
},
{
"name": "mashumaro",
"specs": [
[
"==",
"3.13.1"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.1"
]
]
},
{
"name": "pyside6",
"specs": [
[
"==",
"6.7.2"
]
]
},
{
"name": "pyside6-addons",
"specs": [
[
"==",
"6.7.2"
]
]
},
{
"name": "pyside6-essentials",
"specs": [
[
"==",
"6.7.2"
]
]
},
{
"name": "pyyaml",
"specs": [
[
"==",
"6.0.2"
]
]
},
{
"name": "qdarkstyle",
"specs": [
[
"==",
"3.2.3"
]
]
},
{
"name": "qtpy",
"specs": [
[
"==",
"2.4.1"
]
]
},
{
"name": "shiboken6",
"specs": [
[
"==",
"6.7.2"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"==",
"4.12.2"
]
]
}
],
"lcname": "qt-show-dialog"
}
JSON
