# pybenutils
PyBEN Utilities repository, Contains a variety of useful methods and classes designed to allow easy access to high level operations
### Installation
Win:
> python -m pip install pybenutils -U
macOS:
> python3 -m pip install pybenutils -U
### AutoGUI module
PyBenAutoGui - Class to automate cross platform GUI interactions.
```
options:
-h, --help show this help message and exit
-t TITLE, --title TITLE
Window title
-a APP_PATH, --app_path APP_PATH
Application/Exe path
-b PYWINAUTO_BACKEND, --pywinauto_backend PYWINAUTO_BACKEND
A name of used back-end in Windows OS (values: "win32", "uia")
-c COMMAND, --command COMMAND
Function name to execute in the AutoGui Class
-eh, --extra_help, --no-extra_help
Display extra help about the class and its functions (default: False)
```
> python -m pybenutils.autogui -t "Calculator" -a calc.exe -c get_object_details -b uia
> python3 -m pybenutils.autogui -t "Calculator" -a /Application/Calculator.app -c get_object_details
```
class AutoGui(builtins.object)
| AutoGui(title, app_path, pywinauto_backend='uia')
|
| Methods defined here:
|
| __init__(self, title, app_path, pywinauto_backend='uia')
| Unified interface to interact with Gui Elements
|
| :param title: Window title
| :param app_path: Application/Exe path
| :param pywinauto_backend: A name of used back-end in Windows OS (values: "win32", "uia")
|
| click_on_text(self, text: str)
| Clicks on text object location using pyautogui
|
| find_objects(self, text='', control_type='')
| Returns an iterable containing the matching object
|
| :param text: Text to search, In windows can also be the automation_id
| :param control_type: Filter by control type
| :return: An iterable containing the matching object
|
| focus_on_window(self)
| Focus on the app window - bring to front
|
| get_object_details(self, text='', control_type='')
| Returns an iterable containing dicts of matching objects properties
|
| :param text: Text to search, In windows can also be the automation_id
| :param control_type: Filter by control type
| :return: An iterable containing dicts of matching objects properties
|
| get_object_position_by_text(self, text)
| Return position as tuple (xl, yt, xr, yb) in windows / (x, y) in mac
```
Raw data
{
"_id": null,
"home_page": "https://github.com/DarkFlameBEN/pybenutils.git",
"name": "pybenutils",
"maintainer": null,
"docs_url": null,
"requires_python": ">3",
"maintainer_email": null,
"keywords": null,
"author": "Ben Moskovitch",
"author_email": "\"Ben Moskovitch\" <darkflameben@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/e2/dbef6506cf0bf89a03e57364475f0c20753dc071c7e94237934d801b527c/pybenutils-3.5.0.tar.gz",
"platform": null,
"description": "# pybenutils\r\nPyBEN Utilities repository, Contains a variety of useful methods and classes designed to allow easy access to high level operations \r\n\r\n### Installation\r\nWin:\r\n> python -m pip install pybenutils -U\r\n\r\nmacOS:\r\n> python3 -m pip install pybenutils -U\r\n\r\n### AutoGUI module\r\nPyBenAutoGui - Class to automate cross platform GUI interactions.\r\n```\r\noptions: \r\n -h, --help show this help message and exit \r\n -t TITLE, --title TITLE \r\n Window title \r\n -a APP_PATH, --app_path APP_PATH \r\n Application/Exe path \r\n -b PYWINAUTO_BACKEND, --pywinauto_backend PYWINAUTO_BACKEND \r\n A name of used back-end in Windows OS (values: \"win32\", \"uia\") \r\n -c COMMAND, --command COMMAND \r\n Function name to execute in the AutoGui Class \r\n -eh, --extra_help, --no-extra_help \r\n Display extra help about the class and its functions (default: False)\r\n\r\n```\r\n\r\n> python -m pybenutils.autogui -t \"Calculator\" -a calc.exe -c get_object_details -b uia\r\n\r\n> python3 -m pybenutils.autogui -t \"Calculator\" -a /Application/Calculator.app -c get_object_details\r\n\r\n```\r\nclass AutoGui(builtins.object)\r\n | AutoGui(title, app_path, pywinauto_backend='uia')\r\n | \r\n | Methods defined here:\r\n | \r\n | __init__(self, title, app_path, pywinauto_backend='uia')\r\n | Unified interface to interact with Gui Elements\r\n | \r\n | :param title: Window title\r\n | :param app_path: Application/Exe path\r\n | :param pywinauto_backend: A name of used back-end in Windows OS (values: \"win32\", \"uia\")\r\n | \r\n | click_on_text(self, text: str)\r\n | Clicks on text object location using pyautogui\r\n | \r\n | find_objects(self, text='', control_type='')\r\n | Returns an iterable containing the matching object\r\n | \r\n | :param text: Text to search, In windows can also be the automation_id\r\n | :param control_type: Filter by control type\r\n | :return: An iterable containing the matching object\r\n | \r\n | focus_on_window(self)\r\n | Focus on the app window - bring to front\r\n | \r\n | get_object_details(self, text='', control_type='')\r\n | Returns an iterable containing dicts of matching objects properties\r\n | \r\n | :param text: Text to search, In windows can also be the automation_id\r\n | :param control_type: Filter by control type\r\n | :return: An iterable containing dicts of matching objects properties\r\n | \r\n | get_object_position_by_text(self, text)\r\n | Return position as tuple (xl, yt, xr, yb) in windows / (x, y) in mac\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "PyBEN Utilities repository",
"version": "3.5.0",
"project_urls": {
"Homepage": "https://github.com/DarkFlameBEN/pybenutils.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80ea68510f1a183b57c6a419a9e1e141381d896b233419740378ff9be33d20e6",
"md5": "b1851b9e20f088d7f9d455e1e8c7df4f",
"sha256": "7d7fc04374d0250a2302bc81ec43e4ec09e5930f8ae6210b597ea1583512ab10"
},
"downloads": -1,
"filename": "pybenutils-3.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1851b9e20f088d7f9d455e1e8c7df4f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3",
"size": 51028,
"upload_time": "2024-09-04T09:30:36",
"upload_time_iso_8601": "2024-09-04T09:30:36.584762Z",
"url": "https://files.pythonhosted.org/packages/80/ea/68510f1a183b57c6a419a9e1e141381d896b233419740378ff9be33d20e6/pybenutils-3.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6fe2dbef6506cf0bf89a03e57364475f0c20753dc071c7e94237934d801b527c",
"md5": "5df23934885da60d5ef8b462aa52cea7",
"sha256": "39f4be3fef3aa2076c5aa86cbc1db91ee0e18784458a9bd3e6ded892c14c6e0f"
},
"downloads": -1,
"filename": "pybenutils-3.5.0.tar.gz",
"has_sig": false,
"md5_digest": "5df23934885da60d5ef8b462aa52cea7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3",
"size": 44188,
"upload_time": "2024-09-04T09:30:38",
"upload_time_iso_8601": "2024-09-04T09:30:38.351204Z",
"url": "https://files.pythonhosted.org/packages/6f/e2/dbef6506cf0bf89a03e57364475f0c20753dc071c7e94237934d801b527c/pybenutils-3.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 09:30:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DarkFlameBEN",
"github_project": "pybenutils",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pybenutils"
}
JSON
