Skip to main content

Python SDK for hyperbrowser

Project description

Hyperbrowser Python SDK

Checkout the full documentation here

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 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

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()

Project details


Release history Release notifications | RSS feed

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.44.0.tar.gz (22.6 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.44.0-py3-none-any.whl (46.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hyperbrowser-0.44.0.tar.gz
Algorithm Hash digest
SHA256 9055e87fbd70d517e5ab7bba8ab6bad9515af6633c713f10152e83f32615df1b
MD5 e4c44df0ef9a2ebf210de7ff694f5cc9
BLAKE2b-256 48285731cb9ee83162df1b283df395be5b2b748b5168f315621ff55a36887496

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for hyperbrowser-0.44.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0f966fa3ec7b566afea39ae3fceeddee55a2ecd8086bc6ccbbc91ea71a6ac36
MD5 95d02f89beae6518b2055c4f5b5a739f
BLAKE2b-256 9a7b9ea46aea0e1006c3eca1681a405fa3c8f60f765ff82cbf1d292c47e55e6b

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