## Vision Browser Python API Wrapper
<div align="center">
<a href="https://pypi.org/project/visionbrowser/">
<img src="https://img.shields.io/pypi/v/visionbrowser.svg" alt="PyPI Version" />
</a>
<a href="https://pypi.org/project/visionbrowser/">
<img src="https://img.shields.io/pypi/pyversions/visionbrowser.svg" alt="Python Versions" />
</a>
<a href="https://pypi.org/project/visionbrowser/">
<img src="https://img.shields.io/pypi/status/visionbrowser.svg" alt="Development Status" />
</a>
<a href="https://pypi.org/project/visionbrowser/">
<img src="https://img.shields.io/pypi/l/visionbrowser.svg" alt="License" />
</a>
</div>
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/3e/1b/e0a9ead72f79734ca14b47f8bcd9e9cdcb4639700256683c8a77e6a78f04/visionbrowser-0.0.3.tar.gz",
"platform": null,
"description": "\r\n## Vision Browser Python API Wrapper\r\n\r\n\r\n\r\n<div align=\"center\">\r\n\r\n <a href=\"https://pypi.org/project/visionbrowser/\">\r\n\r\n <img src=\"https://img.shields.io/pypi/v/visionbrowser.svg\" alt=\"PyPI Version\" />\r\n\r\n </a>\r\n\r\n <a href=\"https://pypi.org/project/visionbrowser/\">\r\n\r\n <img src=\"https://img.shields.io/pypi/pyversions/visionbrowser.svg\" alt=\"Python Versions\" />\r\n\r\n </a>\r\n\r\n <a href=\"https://pypi.org/project/visionbrowser/\">\r\n\r\n <img src=\"https://img.shields.io/pypi/status/visionbrowser.svg\" alt=\"Development Status\" />\r\n\r\n </a>\r\n\r\n <a href=\"https://pypi.org/project/visionbrowser/\">\r\n\r\n <img src=\"https://img.shields.io/pypi/l/visionbrowser.svg\" alt=\"License\" />\r\n\r\n </a>\r\n\r\n</div>\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.3",
"project_urls": null,
"split_keywords": [
"python",
" undetected-browser",
" browser",
" vision",
" visionbrowser",
" api",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf69ba3968b5ea133c291830193dbee46cb5e1856a4176fb8ac11543d3ee911b",
"md5": "afaf54a8a0ffb575b50b0b403c5fcd75",
"sha256": "1b9fb97672d798dc2d04995c60cb7d53b471a76e1b285d531b8ccbd34903d9bf"
},
"downloads": -1,
"filename": "visionbrowser-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afaf54a8a0ffb575b50b0b403c5fcd75",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6664,
"upload_time": "2024-08-25T17:32:05",
"upload_time_iso_8601": "2024-08-25T17:32:05.547467Z",
"url": "https://files.pythonhosted.org/packages/cf/69/ba3968b5ea133c291830193dbee46cb5e1856a4176fb8ac11543d3ee911b/visionbrowser-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e1be0a9ead72f79734ca14b47f8bcd9e9cdcb4639700256683c8a77e6a78f04",
"md5": "6d64bbff2622066d5471ccd67ff84861",
"sha256": "605f0ffbe7fdfd86c68cc0d05dd90c90eedac9b6c28cabac7ad9e9b7c7fcfcfb"
},
"downloads": -1,
"filename": "visionbrowser-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "6d64bbff2622066d5471ccd67ff84861",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7063,
"upload_time": "2024-08-25T17:32:06",
"upload_time_iso_8601": "2024-08-25T17:32:06.544499Z",
"url": "https://files.pythonhosted.org/packages/3e/1b/e0a9ead72f79734ca14b47f8bcd9e9cdcb4639700256683c8a77e6a78f04/visionbrowser-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 17:32:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "visionbrowser"
}
JSON