browserrig 0.1.0__tar.gz

browserrig-0.1.0/.env.example

@@ -0,0 +1,10 @@
+# Credentials belong to the provider selected by your host application.
+OPENAI_API_KEY=
+OPENAI_MODEL=gpt-6.1-terra
+# BROWSERRIG_CHROME=C:/Program Files/Google/Chrome/Application/chrome.exe
+
+# Optional tracing: docker compose up -d --wait, then add --trace-content to the example.
+# --trace captures metadata only; --trace-content includes model/tool inputs and outputs.
+# OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://127.0.0.1:6006/v1/traces
+# OTEL_SERVICE_NAME=browserrig
+# PHOENIX_PROJECT_NAME=browserrig

browserrig-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+*.js text eol=lf
+*.mjs text eol=lf

browserrig-0.1.0/.github/workflows/checks.yml

@@ -0,0 +1,89 @@
+name: checks
+
+on:
+  push:
+    branches: ['**']
+  pull_request:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  offline:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python: ['3.12', '3.13', '3.14']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv sync --locked --extra openai --extra mcp --extra otel
+      - run: uv run --no-sync prek validate-config .pre-commit-config.yml
+      - run: uv run --no-sync ruff check browserrig examples tests
+      - run: uv run --no-sync ruff format --check browserrig examples tests
+      - run: uv run --no-sync pylint browserrig examples tests
+      - run: uv run --no-sync ty check
+      - run: uv run --no-sync smelt check --fail-on warning --format github
+      - run: uv run --no-sync pytest -m "not integration"
+      - name: Check release metadata
+        run: uv run --no-sync python tests/check_release.py
+      - run: uv build
+      - name: Check installed wheel in a clean environment
+        run: uv run --no-sync python tests/check_distribution.py
+      - run: uv run --no-sync python -m examples.openai_agent --help
+
+  javascript:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run lint
+      - run: pnpm run format:check
+
+  chrome:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: '3.14'
+      - uses: browser-actions/setup-chrome@v2
+        id: chrome
+      - name: Allow Chrome sandbox user namespaces
+        env:
+          BROWSERRIG_CHROME: ${{ steps.chrome.outputs.chrome-path }}
+        run: |
+          # Ubuntu restricts user namespaces for binaries outside packaged browser paths.
+          # Allow only this Chrome for Testing binary to use its sandbox.
+          # https://chromium.googlesource.com/chromium/src/+/main/docs/security/apparmor-userns-restrictions.md
+          cat <<EOF | sudo tee /etc/apparmor.d/browserrig-chrome > /dev/null
+          abi <abi/4.0>,
+          include <tunables/global>
+
+          profile browserrig-chrome "$BROWSERRIG_CHROME" flags=(unconfined) {
+            userns,
+          }
+          EOF
+          sudo apparmor_parser -r /etc/apparmor.d/browserrig-chrome
+      - name: Check Chrome startup
+        env:
+          BROWSERRIG_CHROME: ${{ steps.chrome.outputs.chrome-path }}
+        run: timeout 20s "$BROWSERRIG_CHROME" --headless=new --dump-dom about:blank
+      - run: uv sync --locked
+      - run: uv run --no-sync pytest -m integration
+        env:
+          BROWSERRIG_CHROME: ${{ steps.chrome.outputs.chrome-path }}
+
+      - name: Direct browser example smoke test
+        run: uv run --no-sync python -m examples.direct_browser --url about:blank
+        env:
+          BROWSERRIG_CHROME: ${{ steps.chrome.outputs.chrome-path }}

browserrig-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,83 @@
+name: Release package
+
+on:
+  push:
+    tags: ['v*']
+  release:
+    types: [published]
+  # A manual run checks and builds only. Publishing requires a tag or release.
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.event.release.tag_name || github.ref_name }}
+  cancel-in-progress: false
+
+jobs:
+  checks:
+    uses: ./.github/workflows/checks.yml
+
+  build:
+    name: Build and verify release artifacts
+    needs: checks
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@v6
+        with:
+          version: '0.9.2'
+          python-version: '3.14'
+      - name: Validate version, tag and main ancestry
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name || (github.ref_type == 'tag' && github.ref_name) || '' }}
+        run: |
+          args=()
+          if [[ -n "$RELEASE_TAG" ]]; then
+            git merge-base --is-ancestor HEAD origin/main || {
+              echo 'Release tags must point to a commit on main.' >&2
+              exit 1
+            }
+            args+=(--tag "$RELEASE_TAG")
+          fi
+          uv run --no-project python tests/check_release.py "${args[@]}"
+          echo "SOURCE_DATE_EPOCH=$(git show -s --format=%ct HEAD)" >> "$GITHUB_ENV"
+      # uv builds the wheel from the sdist, so both upload artifacts are exercised.
+      - run: uv build --out-dir dist/release
+      - name: Check PyPI metadata and README rendering
+        run: uvx twine check --strict dist/release/*
+      - name: Check installed release wheel in a clean environment
+        run: uv run --no-project python tests/check_distribution.py dist/release
+      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: python-release-distributions
+          path: dist/release/*
+          if-no-files-found: error
+          retention-days: 30
+
+  publish:
+    name: Publish verified artifacts to PyPI
+    if: github.event_name == 'push' || github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    environment:
+      name: pypi
+      url: https://pypi.org/project/browserrig/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
+        with:
+          name: python-release-distributions
+          path: dist/
+      - name: Publish with PyPI Trusted Publishing
+        uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # release/v1
+        with:
+          # Tag pushes and published releases can refer to the same version.
+          skip-existing: true

browserrig-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.uv-cache/
+.smelt_cache/
+dist/
+build/
+*.egg-info/
+.env
+.browserrig/
+node_modules/
+
+# Exported Phoenix traces (px trace list ./traces)
+traces/
+evals/results/

browserrig-0.1.0/.pre-commit-config.yml

@@ -0,0 +1,47 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff
+        name: Ruff lint
+        entry: uv run --locked ruff check browserrig examples tests
+        language: system
+        files: '^((browserrig|examples|tests)/.*\.py|pyproject\.toml|uv\.lock)$'
+        pass_filenames: false
+      - id: ruff-format
+        name: Ruff format
+        entry: uv run --locked ruff format --check browserrig examples tests
+        language: system
+        files: '^((browserrig|examples|tests)/.*\.py|pyproject\.toml|uv\.lock)$'
+        pass_filenames: false
+      - id: pylint
+        name: Pylint
+        entry: uv run --locked pylint browserrig examples tests
+        language: system
+        files: '^((browserrig|examples|tests)/.*\.py|pyproject\.toml|uv\.lock)$'
+        pass_filenames: false
+        require_serial: true
+      - id: ty
+        name: ty
+        entry: uv run --locked ty check
+        language: system
+        files: '^((browserrig|examples|tests)/.*\.py|pyproject\.toml|uv\.lock)$'
+        pass_filenames: false
+      - id: smelt
+        name: Smelt
+        entry: uv run --locked smelt check --fail-on warning
+        language: system
+        always_run: true
+        pass_filenames: false
+        require_serial: true
+      - id: eslint
+        name: ESLint
+        entry: pnpm run lint
+        language: system
+        files: '(\.(js|mjs)$|^package\.json$|^pnpm-lock\.yaml$)'
+        pass_filenames: false
+      - id: prettier
+        name: JavaScript format
+        entry: pnpm run format:check
+        language: system
+        files: '(\.(js|mjs)$|^\.prettier(rc\.json|ignore)$|^package\.json$|^pnpm-lock\.yaml$)'
+        pass_filenames: false

browserrig-0.1.0/.prettierignore

@@ -0,0 +1,7 @@
+.venv/
+.pytest_cache/
+.ruff_cache/
+.browserrig/
+**/__pycache__/
+build/
+dist/

browserrig-0.1.0/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "bracketSpacing": false,
+  "printWidth": 88,
+  "endOfLine": "lf"
+}

browserrig-0.1.0/.smelt/debt.json

@@ -0,0 +1,56 @@
+{
+  "version": 2,
+  "violations": [
+    {
+      "code": "SMT420",
+      "path": "tests/test_browser_composition.py",
+      "message": "test accesses private production name browserrig.Observe._page_key",
+      "fingerprints": [
+        "a1be727efcd1fb823790a19dde96d4f8",
+        "a1be727efcd1fb823790a19dde96d4f8",
+        "a1be727efcd1fb823790a19dde96d4f8",
+        "a1be727efcd1fb823790a19dde96d4f8"
+      ]
+    },
+    {
+      "code": "SMT420",
+      "path": "tests/test_browser_composition.py",
+      "message": "test accesses private production name browserrig.tools.mouse._image_point",
+      "fingerprints": [
+        "57c4c77eee7729fb96b74d1b3216eecb"
+      ]
+    },
+    {
+      "code": "SMT420",
+      "path": "tests/test_process.py",
+      "message": "test accesses private production name browserrig.browser.process._active_endpoint",
+      "fingerprints": [
+        "dfa52a2d2d3e26242ede3e4d0b8cfa66"
+      ]
+    },
+    {
+      "code": "SMT420",
+      "path": "tests/test_secrets.py",
+      "message": "test accesses private production name browserrig.observation.capture._redact",
+      "fingerprints": [
+        "ed566f1f220074b0fd456472fa517c5c"
+      ]
+    },
+    {
+      "code": "SMT420",
+      "path": "tests/test_tab_state.py",
+      "message": "test accesses private production name browserrig.browser.favicon._media_type",
+      "fingerprints": [
+        "4778f806842fe755f1da42cf078eaa06"
+      ]
+    },
+    {
+      "code": "SMT420",
+      "path": "tests/test_terminal.py",
+      "message": "test accesses private production name browserrig.terminal._event_record",
+      "fingerprints": [
+        "a1c9880469f7f66d5e1e8b9a3399f5f4"
+      ]
+    }
+  ]
+}