| Name | pyGATs JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Automate end-to-end and exploratory testing |
| upload_time | 2024-06-13 11:23:45 |
| maintainer | None |
| docs_url | None |
| author | vsysoev |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2022 IntegraSDL Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
gui
testing
automatic
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyGATs
[](https://github.com/IntegraSDL/pygats/actions/workflows/pylint.yml)
[](https://github.com/IntegraSDL/pygats/actions/workflows/python-package.yml)
[](https://github.com/IntegraSDL/pygats/actions/workflows/python-publish.yml)
**This library is in development process. API is not stabilized yet. It will
be completely changed soon.**
This is python3 library which combines power of pyautogui, opencv, tesseract,
markdown and other staff to automate end-to-end and exploratory testing.
This library might be used to automate testing process with Xvbf and docker.
pyGATs depends on pyautogui, pytesseract, opencv and others. Please see section
dependencies in pyproject.toml file.
## How to test
```
python3 -m pytest
```
## Linter
```
pylint $(git ls-files '*.py')
```
## Build documentation
```
cd docs
make html
```
# Example Usage
```python
"""
Header: Description of test suites
"""
import pygats.pygats as pygats
import pygats.recog as recog
from pygats.formatters import MarkdownFormatter as MD
ctx = pygats.Context(formatter=MD(), timeout=0.5)
def test_function():
"""
Definition: definition of the test function
Actions:
1: action 1
2: action 2
3: ...
Expected: expected result
"""
pygats.run_action(ctx)
...
pygats.run_action(ctx, action_2_function)
...
...
test_suites = [
test_function,
...
]
if __name__ == '__main__':
pygats.run(ctx, test_suites)
```
As a result of executing the script, we get a report in Markdown format in the "output" directory
## Usage features
Docstring of the document and the test functions are required attributes to get the required test report.
> If you do not specify a docstring, the corresponding report entries will be replaced with standard entries.
Docstring must be in YAML format. Docstring may contain additional entries in this format, if necessary.
When writing a test function, it is necessary to have a docstring that has 3 key entries:
- Definition - definition of the test function, what it checks;
- Actions - a list of actions to perform the verification;
- Expected - expected result.
`run_action()` function is required to print the description of the action before executing it. It can be used in 2 ways:
- `pygats.run_action(ctx)`, after which the steps of executing the action are performed;
- `pygats.run_action(ctx, function, **kwargs)`. In this case, we pass a function containing the necessary steps. If it has additional arguments, we pass them separated by commas. The arguments must be named.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyGATs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "gui, testing, automatic",
"author": "vsysoev",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/07/e4/51cf564db7810ad5e48294a4bf7acfbe6cc2673a19837f118965127debb1/pygats-0.1.0.tar.gz",
"platform": null,
"description": "# pyGATs\n\n[](https://github.com/IntegraSDL/pygats/actions/workflows/pylint.yml)\n[](https://github.com/IntegraSDL/pygats/actions/workflows/python-package.yml)\n[](https://github.com/IntegraSDL/pygats/actions/workflows/python-publish.yml)\n\n**This library is in development process. API is not stabilized yet. It will\nbe completely changed soon.**\n\n\nThis is python3 library which combines power of pyautogui, opencv, tesseract, \nmarkdown and other staff to automate end-to-end and exploratory testing.\n\nThis library might be used to automate testing process with Xvbf and docker.\n\npyGATs depends on pyautogui, pytesseract, opencv and others. Please see section\ndependencies in pyproject.toml file.\n\n\n## How to test\n\n```\npython3 -m pytest\n```\n\n## Linter\n\n```\npylint $(git ls-files '*.py')\n```\n## Build documentation\n\n```\ncd docs\nmake html\n```\n\n# Example Usage\n\n```python\n\"\"\"\nHeader: Description of test suites\n\"\"\"\nimport pygats.pygats as pygats\nimport pygats.recog as recog\n\nfrom pygats.formatters import MarkdownFormatter as MD\n\n\nctx = pygats.Context(formatter=MD(), timeout=0.5)\n\n\ndef test_function():\n \"\"\"\n Definition: definition of the test function\n\n Actions:\n 1: action 1\n 2: action 2\n 3: ...\n\n Expected: expected result\n \"\"\"\n pygats.run_action(ctx)\n ...\n pygats.run_action(ctx, action_2_function)\n ...\n\n\n...\n\n\ntest_suites = [\n test_function,\n ...\n]\n\n\nif __name__ == '__main__':\n pygats.run(ctx, test_suites)\n\n```\n\nAs a result of executing the script, we get a report in Markdown format in the \"output\" directory\n\n## Usage features\n\nDocstring of the document and the test functions are required attributes to get the required test report.\n> If you do not specify a docstring, the corresponding report entries will be replaced with standard entries.\n\nDocstring must be in YAML format. Docstring may contain additional entries in this format, if necessary.\n\nWhen writing a test function, it is necessary to have a docstring that has 3 key entries:\n- Definition - definition of the test function, what it checks;\n- Actions - a list of actions to perform the verification;\n- Expected - expected result.\n\n`run_action()` function is required to print the description of the action before executing it. It can be used in 2 ways:\n- `pygats.run_action(ctx)`, after which the steps of executing the action are performed;\n- `pygats.run_action(ctx, function, **kwargs)`. In this case, we pass a function containing the necessary steps. If it has additional arguments, we pass them separated by commas. The arguments must be named.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 IntegraSDL Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Automate end-to-end and exploratory testing",
"version": "0.1.0",
"project_urls": {
"repository": "https://github.com/IntegraSDL/pymagic-autogui.git"
},
"split_keywords": [
"gui",
" testing",
" automatic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6aa0ff8f9fe036536d5d9c3bed84f84a83313383143bf6902555d94ea51ba163",
"md5": "ea449db71a2ae35578222fde0038f00f",
"sha256": "d82faa3c056ba364b8d6cc2739056183829443bf9ac787aaf4e1a8f8f8793764"
},
"downloads": -1,
"filename": "pyGATs-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea449db71a2ae35578222fde0038f00f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18862,
"upload_time": "2024-06-13T11:23:44",
"upload_time_iso_8601": "2024-06-13T11:23:44.124808Z",
"url": "https://files.pythonhosted.org/packages/6a/a0/ff8f9fe036536d5d9c3bed84f84a83313383143bf6902555d94ea51ba163/pyGATs-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "07e451cf564db7810ad5e48294a4bf7acfbe6cc2673a19837f118965127debb1",
"md5": "5d30f769cc9b8f2e8280faf7f1b6d24f",
"sha256": "c944aeab4e4ad68359471f8ab017774a7610fe0d9b34feb240650b9d6bb97d73"
},
"downloads": -1,
"filename": "pygats-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5d30f769cc9b8f2e8280faf7f1b6d24f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 16952,
"upload_time": "2024-06-13T11:23:45",
"upload_time_iso_8601": "2024-06-13T11:23:45.404620Z",
"url": "https://files.pythonhosted.org/packages/07/e4/51cf564db7810ad5e48294a4bf7acfbe6cc2673a19837f118965127debb1/pygats-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-13 11:23:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IntegraSDL",
"github_project": "pymagic-autogui",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pygats"
}
