## Vision Browser Python API Wrapper
[](https://pypi.org/project/visionbrowser/)
Asynchronous Python library for interacting with the Vision Browser API. Allows you to manage browser profiles, folders, and other entities through a convenient interface.
## Installation
```bash
pip install visionbrowser
```
## Usage example
```python
import asyncio
import visionbrowser
async def main():
vb_api = visionbrowser.Api()
profiles = await vb_api.get_launched_profiles(token='YOUR_API_TOKEN')
print(profiles)
if __name__ == '__main__':
asyncio.run(main())
```
## Available methods
We have a complete list of available functions in the original API documentation. You can view them on the website https://docs.browser.vision.
To use each method you need, you need to define its class.
Example:
```python
import visionbrowser
vb_api = visionbrowser.Api() # For API
vb_profiles = visionbrowser.Profiles() # For Profiles
vb_folders = visionbrowser.Folders() # For Folders
# And other
```
## Error handling
The library raises the following exceptions:
* `visionbrowser.exceptions.FailedConnection`: Error connecting to the API.
* `visionbrowser.exceptions.APIError`: Error returned by the Vision Browser API.
There are also warnings. They are not fully implemented, but there is an example.
```python
await visionbrowser.Api.start_profile(token=token, profile_id=profile_id, folder_id=folder_id)
# If your browser was already launched inside the Vision App, then you cannot launch it through the API, and the code will display:
# WARNING:visionbrowser.api:The port was found to be empty after the application/process returned. Most likely the profile was launched inside Vision, or some other issue occurred.
```
## Examples
See usage examples in the `examples` folder.
---
## Contributing
We will gladly welcome all comments and wishes. 😊\
If you want to contact me, please send me a private message on Github **(europecdc)**.
Raw data
{
"_id": null,
"home_page": null,
"name": "visionbrowser",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, undetected-browser, browser, vision, visionbrowser, api, wrapper",
"author": "europecdc",
"author_email": "europecdc@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/72/8c/729c7d9cbb3cbff51242933836a1dfd64d49f33af378a8cfd0c906cdb852/visionbrowser-0.0.1.tar.gz",
"platform": null,
"description": "\r\n## Vision Browser Python API Wrapper\r\n\r\n\r\n\r\n[](https://pypi.org/project/visionbrowser/)\r\n\r\n\r\n\r\nAsynchronous Python library for interacting with the Vision Browser API. Allows you to manage browser profiles, folders, and other entities through a convenient interface.\r\n\r\n\r\n\r\n## Installation\r\n\r\n\r\n\r\n```bash\r\n\r\npip install visionbrowser\r\n\r\n```\r\n\r\n\r\n\r\n## Usage example\r\n\r\n\r\n\r\n```python\r\n\r\nimport asyncio\r\n\r\nimport visionbrowser\r\n\r\n\r\n\r\nasync def main():\r\n\r\n vb_api = visionbrowser.Api()\r\n\r\n profiles = await vb_api.get_launched_profiles(token='YOUR_API_TOKEN')\r\n\r\n print(profiles)\r\n\r\n\r\n\r\nif __name__ == '__main__':\r\n\r\n asyncio.run(main())\r\n\r\n```\r\n\r\n\r\n\r\n## Available methods\r\n\r\n\r\n\r\nWe have a complete list of available functions in the original API documentation. You can view them on the website https://docs.browser.vision.\r\n\r\n\r\n\r\nTo use each method you need, you need to define its class.\r\n\r\nExample:\r\n\r\n\r\n\r\n```python\r\n\r\nimport visionbrowser\r\n\r\n\r\n\r\nvb_api = visionbrowser.Api() # For API\r\n\r\nvb_profiles = visionbrowser.Profiles() # For Profiles\r\n\r\nvb_folders = visionbrowser.Folders() # For Folders\r\n\r\n# And other\r\n\r\n```\r\n\r\n## Error handling\r\n\r\n\r\n\r\nThe library raises the following exceptions:\r\n\r\n\r\n\r\n* `visionbrowser.exceptions.FailedConnection`: Error connecting to the API.\r\n\r\n* `visionbrowser.exceptions.APIError`: Error returned by the Vision Browser API.\r\n\r\n\r\n\r\nThere are also warnings. They are not fully implemented, but there is an example.\r\n\r\n\r\n\r\n```python\r\n\r\nawait visionbrowser.Api.start_profile(token=token, profile_id=profile_id, folder_id=folder_id)\r\n\r\n\r\n\r\n# If your browser was already launched inside the Vision App, then you cannot launch it through the API, and the code will display:\r\n\r\n# WARNING:visionbrowser.api:The port was found to be empty after the application/process returned. Most likely the profile was launched inside Vision, or some other issue occurred.\r\n\r\n```\r\n\r\n## Examples\r\n\r\n\r\n\r\nSee usage examples in the `examples` folder.\r\n\r\n\r\n\r\n---\r\n\r\n\r\n\r\n## Contributing\r\n\r\n\r\n\r\nWe will gladly welcome all comments and wishes. \ud83d\ude0a\\\r\n\r\nIf you want to contact me, please send me a private message on Github **(europecdc)**.\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Async API wrapper for Vision Browser",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [
"python",
" undetected-browser",
" browser",
" vision",
" visionbrowser",
" api",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8a4ed62664cf90a54be4d3008fa2a2a462a24120e4a9cafe2d4711671d94a77",
"md5": "bd16922fe481023a7e1c0bd7d017b827",
"sha256": "f8beec7fcae81329a87dcb9030255a18de91b5745868419ab19eaa63b95e168a"
},
"downloads": -1,
"filename": "visionbrowser-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd16922fe481023a7e1c0bd7d017b827",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6569,
"upload_time": "2024-06-23T23:13:27",
"upload_time_iso_8601": "2024-06-23T23:13:27.618084Z",
"url": "https://files.pythonhosted.org/packages/a8/a4/ed62664cf90a54be4d3008fa2a2a462a24120e4a9cafe2d4711671d94a77/visionbrowser-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "728c729c7d9cbb3cbff51242933836a1dfd64d49f33af378a8cfd0c906cdb852",
"md5": "5b36583c09912d780f53e9d833bd5401",
"sha256": "e54fa5c32ac44a2bfb78dd05dfcc5315da4911130be45b933d69154c7f386ea8"
},
"downloads": -1,
"filename": "visionbrowser-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5b36583c09912d780f53e9d833bd5401",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6854,
"upload_time": "2024-06-23T23:13:29",
"upload_time_iso_8601": "2024-06-23T23:13:29.457167Z",
"url": "https://files.pythonhosted.org/packages/72/8c/729c7d9cbb3cbff51242933836a1dfd64d49f33af378a8cfd0c906cdb852/visionbrowser-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-23 23:13:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "visionbrowser"
}
JSON