Skip to main content

Python SDK for hyperbrowser

Project description

Installation

Currently Hyperbrowser supports creating a browser session in two ways:

  • Async Client
  • Sync Client

It can be installed from pypi by running :

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

import asyncio
from pyppeteer import connect
from hyperbrowser.client.async_client import AsyncHyperbrowser as Hyperbrowser

HYPERBROWSER_API_KEY = "test-key"

async def main():
    client = Hyperbrowser(api_key=HYPERBROWSER_API_KEY)
    session = await client.create_session()

    ws_endpoint = f"{session.websocket_url}&apiKey={HYPERBROWSER_API_KEY}"
    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()
    print("Session completed!")

# Run the asyncio event loop
asyncio.get_event_loop().run_until_complete(main())

Sync

from playwright.sync_api import sync_playwright
from hyperbrowser.client.sync import Hyperbrowser

HYPERBROWSER_API_KEY = "test-key"

def main():
    client = Hyperbrowser(api_key=HYPERBROWSER_API_KEY)
    session = client.create_session()

    ws_endpoint = f"{session.websocket_url}&apiKey={HYPERBROWSER_API_KEY}"

    # 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!")

# Run the asyncio event loop
main()

Project details


Release history Release notifications | RSS feed

This version

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hyperbrowser-0.1.0.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hyperbrowser-0.1.0-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file hyperbrowser-0.1.0.tar.gz.

File metadata

  • Download URL: hyperbrowser-0.1.0.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.14

File hashes

Hashes for hyperbrowser-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9817efde76372b166023efbd8326aabc6285c34583e9742ba0b8190354c182ff
MD5 dd4a9eab94a3a399fafe3c1ded00ad73
BLAKE2b-256 3063be1f60d7b85cc6c2ff8f9ef7ebd8363bc9f948496fd05f01a0000724adca

See more details on using hashes here.

File details

Details for the file hyperbrowser-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hyperbrowser-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.14

File hashes

Hashes for hyperbrowser-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e62f3e00b5cb034a22e9a8cd7184a9a5d94d4074220ee9f6c772f0f298751a4f
MD5 669598ac0cd7d8024278ccd2d6f3a521
BLAKE2b-256 03f770039657be68f11b64bc36de6eb9d9007dc37cd6c94ab2fcab93bf1c08af

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page