| Name | hyperbrowser JSON |
| Version |
0.52.0
JSON |
| download |
| home_page | None |
| Summary | Python SDK for hyperbrowser |
| upload_time | 2025-07-22 19:22:24 |
| maintainer | None |
| docs_url | None |
| author | Nikhil Shahi |
| requires_python | <4.0,>=3.8 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Hyperbrowser Python SDK
Checkout the full documentation [here](https://docs.hyperbrowser.ai/)
## Installation
Currently Hyperbrowser supports creating a browser session in two ways:
- Async Client
- Sync Client
It can be installed from `pypi` by running :
```shell
pip install hyperbrowser
```
## Configuration
Both the sync and async client follow similar configuration params
### API Key
The API key can be configured either from the constructor arguments or environment variables using `HYPERBROWSER_API_KEY`
## Usage
### Async
```python
import asyncio
from pyppeteer import connect
from hyperbrowser import AsyncHyperbrowser
HYPERBROWSER_API_KEY = "test-key"
async def main():
async with AsyncHyperbrowser(api_key=HYPERBROWSER_API_KEY) as client:
session = await client.sessions.create()
ws_endpoint = session.ws_endpoint
browser = await connect(browserWSEndpoint=ws_endpoint, defaultViewport=None)
# Get pages
pages = await browser.pages()
if not pages:
raise Exception("No pages available")
page = pages[0]
# Navigate to a website
print("Navigating to Hacker News...")
await page.goto("https://news.ycombinator.com/")
page_title = await page.title()
print("Page title:", page_title)
await page.close()
await browser.disconnect()
await client.sessions.stop(session.id)
print("Session completed!")
# Run the asyncio event loop
asyncio.get_event_loop().run_until_complete(main())
```
### Sync
```python
from playwright.sync_api import sync_playwright
from hyperbrowser import Hyperbrowser
HYPERBROWSER_API_KEY = "test-key"
def main():
client = Hyperbrowser(api_key=HYPERBROWSER_API_KEY)
session = client.sessions.create()
ws_endpoint = session.ws_endpoint
# Launch Playwright and connect to the remote browser
with sync_playwright() as p:
browser = p.chromium.connect_over_cdp(ws_endpoint)
context = browser.new_context()
# Get the first page or create a new one
if len(context.pages) == 0:
page = context.new_page()
else:
page = context.pages[0]
# Navigate to a website
print("Navigating to Hacker News...")
page.goto("https://news.ycombinator.com/")
page_title = page.title()
print("Page title:", page_title)
page.close()
browser.close()
print("Session completed!")
client.sessions.stop(session.id)
# Run the asyncio event loop
main()
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "hyperbrowser",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Nikhil Shahi",
"author_email": "nshahi1998@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d4/c0/0c69f10c7f7de905def471251087811fd294afa99c6f68d3661974c14167/hyperbrowser-0.52.0.tar.gz",
"platform": null,
"description": "# Hyperbrowser Python SDK\n\nCheckout the full documentation [here](https://docs.hyperbrowser.ai/)\n\n## Installation\n\nCurrently Hyperbrowser supports creating a browser session in two ways:\n\n- Async Client\n- Sync Client\n\nIt can be installed from `pypi` by running :\n\n```shell\npip install hyperbrowser\n```\n\n## Configuration\n\nBoth the sync and async client follow similar configuration params\n\n### API Key\nThe API key can be configured either from the constructor arguments or environment variables using `HYPERBROWSER_API_KEY`\n\n## Usage\n\n### Async\n\n```python\nimport asyncio\nfrom pyppeteer import connect\nfrom hyperbrowser import AsyncHyperbrowser\n\nHYPERBROWSER_API_KEY = \"test-key\"\n\nasync def main():\n async with AsyncHyperbrowser(api_key=HYPERBROWSER_API_KEY) as client:\n session = await client.sessions.create()\n\n ws_endpoint = session.ws_endpoint\n browser = await connect(browserWSEndpoint=ws_endpoint, defaultViewport=None)\n\n # Get pages\n pages = await browser.pages()\n if not pages:\n raise Exception(\"No pages available\")\n\n page = pages[0]\n\n # Navigate to a website\n print(\"Navigating to Hacker News...\")\n await page.goto(\"https://news.ycombinator.com/\")\n page_title = await page.title()\n print(\"Page title:\", page_title)\n\n await page.close()\n await browser.disconnect()\n await client.sessions.stop(session.id)\n print(\"Session completed!\")\n\n# Run the asyncio event loop\nasyncio.get_event_loop().run_until_complete(main())\n```\n### Sync\n\n```python\nfrom playwright.sync_api import sync_playwright\nfrom hyperbrowser import Hyperbrowser\n\nHYPERBROWSER_API_KEY = \"test-key\"\n\ndef main():\n client = Hyperbrowser(api_key=HYPERBROWSER_API_KEY)\n session = client.sessions.create()\n\n ws_endpoint = session.ws_endpoint\n\n # Launch Playwright and connect to the remote browser\n with sync_playwright() as p:\n browser = p.chromium.connect_over_cdp(ws_endpoint)\n context = browser.new_context()\n \n # Get the first page or create a new one\n if len(context.pages) == 0:\n page = context.new_page()\n else:\n page = context.pages[0]\n \n # Navigate to a website\n print(\"Navigating to Hacker News...\")\n page.goto(\"https://news.ycombinator.com/\")\n page_title = page.title()\n print(\"Page title:\", page_title)\n \n page.close()\n browser.close()\n print(\"Session completed!\")\n client.sessions.stop(session.id)\n\n# Run the asyncio event loop\nmain()\n```\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python SDK for hyperbrowser",
"version": "0.52.0",
"project_urls": {
"Homepage": "https://github.com/hyperbrowserai/python-sdk",
"Repository": "https://github.com/hyperbrowserai/python-sdk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ee4e85dd5d5a54a3e209c284df81aa9cfdab531d4ecc7ffe6a9593c2b591263d",
"md5": "675f3bae711a4ecd3011efdd7a9e3470",
"sha256": "6be638070b275173cfee2a7dce3b56ba0e1555a9302ef2140502e4589a49aeef"
},
"downloads": -1,
"filename": "hyperbrowser-0.52.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "675f3bae711a4ecd3011efdd7a9e3470",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 52430,
"upload_time": "2025-07-22T19:22:23",
"upload_time_iso_8601": "2025-07-22T19:22:23.042674Z",
"url": "https://files.pythonhosted.org/packages/ee/4e/85dd5d5a54a3e209c284df81aa9cfdab531d4ecc7ffe6a9593c2b591263d/hyperbrowser-0.52.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d4c00c69f10c7f7de905def471251087811fd294afa99c6f68d3661974c14167",
"md5": "bba9e945ba5c012ffab000c1c3edd88b",
"sha256": "5793156f04b0b18772472b87a2e73683a0a1a0baf93bdecfc119ea0cfed46f74"
},
"downloads": -1,
"filename": "hyperbrowser-0.52.0.tar.gz",
"has_sig": false,
"md5_digest": "bba9e945ba5c012ffab000c1c3edd88b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 25756,
"upload_time": "2025-07-22T19:22:24",
"upload_time_iso_8601": "2025-07-22T19:22:24.379652Z",
"url": "https://files.pythonhosted.org/packages/d4/c0/0c69f10c7f7de905def471251087811fd294afa99c6f68d3661974c14167/hyperbrowser-0.52.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-22 19:22:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hyperbrowserai",
"github_project": "python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hyperbrowser"
}
