Installation

Requirements

Python Version

Widgetastic.core requires Python 3.10 or higher. We recommend using the latest stable version of Python.

System Requirements

Windows, macOS, or Linux
Internet connection for browser downloads (first-time setup)

Installation Methods

PyPI Installation (Recommended)

The easiest way to install widgetastic.core is using pip:

pip install widgetastic.core

This will install the core library with all required dependencies.

Development Installation

If you want to contribute to the project or need the latest development features:

# Clone the repository
git clone https://github.com/RedHatQE/widgetastic.core.git
cd widgetastic.core

# Create virtual environment and activate it
python -m venv .venv_wt
source .venv_wt/bin/activate

# Install in editable mode
pip install -e .

# Or with development dependencies
pip install -e ".[dev]"

Playwright Setup

Widgetastic.core uses Playwright as its browser automation engine. After installing widgetastic.core, you need to install browser binaries:

# Install browser binaries (required for first-time setup)
playwright install

# Or install specific browsers only like chromium / firefox
playwright install chromium

Note

Browser installation may take several minutes and requires internet connectivity.

Verifying Installation

Create a simple test script to verify everything is working:

# test_installation.py

import os
from playwright.sync_api import sync_playwright
from widgetastic.browser import Browser
from widgetastic.widget import View, Text


class TestView(View):
    title = Text("title")


def test_widgetastic():
    # Get headless mode from environment (set by conftest or CI)
    headless = os.getenv("PLAYWRIGHT_HEADLESS", "false").lower() == "true"

    with sync_playwright() as p:
        browser = p.chromium.launch(headless=headless)
        page = browser.new_page()
        page.goto("https://example.com")

        wt_browser = Browser(page)
        view = TestView(wt_browser)

        print(f"Page title: {view.title.text}")
        print("✅ Widgetastic is working correctly!")

        browser.close()


if __name__ == "__main__":
    test_widgetastic()

Run the script:

python test_installation.py

If you see “✅ Widgetastic is working correctly!” along with the page title, your installation is successful.

Optional Dependencies

For additional functionality, you can install optional dependencies:

Development Tools

pip install "widgetastic.core[dev]"

Testing Dependencies

pip install "widgetastic.core[test]"

Documentation Building

pip install "widgetastic.core[docs]"