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():
    async with Hyperbrowser(api_key=HYPERBROWSER_API_KEY) as client:
        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.2.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.2.0.tar.gz (6.8 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.2.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hyperbrowser-0.2.0.tar.gz
Algorithm Hash digest
SHA256 637585e8f9f5608e44f17030789cc9b7d4486ceb3a379ca82bf94842399a53ec
MD5 67ca515777a9b0ad65690135144ecd92
BLAKE2b-256 3705ae7e8cc612f8f52724fc4c4b2d51fc1c17bb92fcd53fe5d1e82dab63de67

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hyperbrowser-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 10.6 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd3261187e5a1147d63215e9a083d4f2d7932380c3fb1ae6784815bc7595fe95
MD5 07a3362409912196c6929909eb017799
BLAKE2b-256 1d7f179b0ba22b749cd9e944a9d5931f48832da87433245c42b3ec41d5c4be7f

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