| Name | gui-api-tkinter JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | GUI API for interfacing and testing with tkinter |
| upload_time | 2024-12-11 22:49:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
gui
tkinter
test
verification
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
* website: <https://arrizza.com/python-gui-api-tkinter>
* installation: see <https://arrizza.com/setup-common>
## Summary
This module contains a set of simple base classes that can be
used for test or verification purposes on GUIs based on Tkinter.
A test harness can connect to this class using a TCPIP socket and
get the current screen content, press an x,y coordinate, and
invoke a menu item.
The typical scenario is to create a Tkinter GUI app and add the
gui-api-tkinter server into it. Then a test harness is built
using gui_api_harness and that is used by pytest (or whatever
other test driver you wish) to run tests against the GUI.
For a more detailed description of the available commands and
responses see gui_api.md
## Scripts
* See [Quick Start](https://arrizza.com/user-guide-quick-start) for information on using scripts.
* See [xplat-utils submodule](https://arrizza.com/xplat-utils) for information on the submodule.
## Sample code
See the sample directory for a sample client and server. Use
doit script to run the sample server.
```bash
./doit
```
This runs the code in the sample directory. The gui
subdirectory contains a sample Tkinter GUI app which has some
buttons and labels on it. The test harness is then used to
press buttons on the GUI and check that the GUI perform
s the expected behavior. The file sample/test_gui.py runs
those tests.
The pom/ subdirectory holds Page Object Model classes to
simplify the interactions between the test_gui code and the
GUI app.
For a more complex example, see ./ver directory. Invoke those tests using:
```bash
./do_ver
./do_ver -k tp001 # for the first test protocol
# etc.
```
## Other scripts and files
- do_doc: generates doxygen
- do_install: installs python environment
- do_lint: runs static analysis tools
- do_publish: publish the python module
- do_ver: runs verification scripts
- doit: runs a sample GUI client and a sample test harness
- srs.json: holds a list of requirements for the gui api and
the test harness must adhere to
- todo.md known issues to fix/address
Raw data
{
"_id": null,
"home_page": null,
"name": "gui-api-tkinter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "\"J. Arrizza\" <cppgent0@gmail.com>",
"keywords": "gui, tkinter, test, verification",
"author": null,
"author_email": "\"J. Arrizza\" <cppgent0@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ee/f4/64a07d62c181a5a9fc81b6655cc66f2fa24a775ad3fa9f81b2bb31081712/gui_api_tkinter-0.2.0.tar.gz",
"platform": null,
"description": "* website: <https://arrizza.com/python-gui-api-tkinter>\n* installation: see <https://arrizza.com/setup-common>\n\n## Summary\n\nThis module contains a set of simple base classes that can be\nused for test or verification purposes on GUIs based on Tkinter.\n\nA test harness can connect to this class using a TCPIP socket and\nget the current screen content, press an x,y coordinate, and\ninvoke a menu item.\n\nThe typical scenario is to create a Tkinter GUI app and add the\ngui-api-tkinter server into it. Then a test harness is built\nusing gui_api_harness and that is used by pytest (or whatever\nother test driver you wish) to run tests against the GUI.\n\nFor a more detailed description of the available commands and\nresponses see gui_api.md\n\n## Scripts\n\n* See [Quick Start](https://arrizza.com/user-guide-quick-start) for information on using scripts.\n* See [xplat-utils submodule](https://arrizza.com/xplat-utils) for information on the submodule.\n\n## Sample code\n\nSee the sample directory for a sample client and server. Use\ndoit script to run the sample server.\n\n```bash\n./doit\n```\n\nThis runs the code in the sample directory. The gui\nsubdirectory contains a sample Tkinter GUI app which has some\nbuttons and labels on it. The test harness is then used to\npress buttons on the GUI and check that the GUI perform\ns the expected behavior. The file sample/test_gui.py runs\nthose tests.\n\nThe pom/ subdirectory holds Page Object Model classes to\nsimplify the interactions between the test_gui code and the\nGUI app.\n\nFor a more complex example, see ./ver directory. Invoke those tests using:\n\n```bash\n./do_ver\n./do_ver -k tp001 # for the first test protocol\n# etc.\n```\n\n## Other scripts and files\n\n- do_doc: generates doxygen\n- do_install: installs python environment\n- do_lint: runs static analysis tools\n- do_publish: publish the python module\n- do_ver: runs verification scripts\n- doit: runs a sample GUI client and a sample test harness\n- srs.json: holds a list of requirements for the gui api and\n the test harness must adhere to\n- todo.md known issues to fix/address\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "GUI API for interfacing and testing with tkinter",
"version": "0.2.0",
"project_urls": {
"Download": "https://bitbucket.org/arrizza-public/gui-api-tkinter/get/master.zip",
"Source": "https://bitbucket.org/arrizza-public/gui-api-tkinter/src/master",
"Website": "https://arrizza.com/python-gui-api-tkinter"
},
"split_keywords": [
"gui",
" tkinter",
" test",
" verification"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eef464a07d62c181a5a9fc81b6655cc66f2fa24a775ad3fa9f81b2bb31081712",
"md5": "0990db1624c074caf54bc1e64a56681c",
"sha256": "40f8866af97ec35c61afc7625950e5310ce4aec9ecd4f97b2d68fdd40d0debca"
},
"downloads": -1,
"filename": "gui_api_tkinter-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "0990db1624c074caf54bc1e64a56681c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15840,
"upload_time": "2024-12-11T22:49:03",
"upload_time_iso_8601": "2024-12-11T22:49:03.785665Z",
"url": "https://files.pythonhosted.org/packages/ee/f4/64a07d62c181a5a9fc81b6655cc66f2fa24a775ad3fa9f81b2bb31081712/gui_api_tkinter-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 22:49:03",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "arrizza-public",
"bitbucket_project": "gui-api-tkinter",
"lcname": "gui-api-tkinter"
}
