Skip to main content

Cross-platform PWA launcher using Chromium

Project description

py-pwa-launcher

Launch Progressive Web Apps from Python

A Python library for launching Progressive Web Apps (PWAs) using Chromium-based browsers. Automatically detects installed Chromium browsers and launches PWAs in app mode with all necessary flags.

Features

  • 🚀 Launch PWAs with a single function call
  • 🔍 Auto-detect system Chromium-based browsers (Chrome, Edge, Brave, Vivaldi, Opera, Arc)
  • ⚙️ PWA-optimized flags for installation and features
  • 🔒 Custom profiles for isolated PWA data
  • Check PWA support before launching
  • 🧪 Fully tested with comprehensive test suite
  • 🌍 Cross-platform support (Windows, macOS, Linux)

Installation

pip install pwa-launcher

Requirements: You need a Chromium-based browser installed on your system:

  • Google Chrome
  • Microsoft Edge
  • Brave
  • Vivaldi
  • Opera
  • Arc (macOS)
  • Chromium

The library will automatically detect any of these browsers.

Quick Start

Launch a PWA

from pwa_launcher import open_pwa

# Launch a PWA - that's it!
open_pwa("https://weatherlite.app")

Check PWA Support

from pwa_launcher import check_pwa_support

# Check if a URL supports PWA
result = check_pwa_support("https://weatherlite.app")

if result.is_pwa_supported:
    print(f"✓ {result.url} is PWA-ready!")
    print(f"  Manifest: {result.manifest_url}")
    print(f"  Service Worker: {result.service_worker_url}")
else:
    print(f"✗ Not a PWA")
    for error in result.errors:
        print(f"  - {error}")

Launch with Custom Options

from pwa_launcher import open_pwa
from pathlib import Path

# Launch with custom profile and flags
process = open_pwa(
    "https://excalidraw.com",
    user_data_dir=Path("./my_pwa_profile"),
    additional_flags=["--start-maximized"]
)

print(f"Launched PWA (PID: {process.pid})")

Keep Process Alive

By default, each PWA runs in an isolated profile to keep the process alive:

from pwa_launcher import open_pwa

# Auto-generates isolated profile - process stays alive!
process = open_pwa("https://example.com")
print(f"PID: {process.pid}")  # Process won't exit immediately

# To disable auto-profile (may cause process to exit if Chrome is already running):
process = open_pwa("https://example.com", auto_profile=False)

Why this matters: When Chrome reuses an existing profile, it hands off to an already-running Chrome instance and the new process exits immediately. With auto_profile=True (default), each PWA gets its own isolated profile, keeping the process running.

API Reference

open_pwa(url, **kwargs)

Launch a PWA using Chromium browser.

Parameters:

  • url (str): URL to open as PWA (required)
  • chromium_path (Path, optional): Path to Chromium executable (auto-detected if None)
  • user_data_dir (Path, optional): Custom browser profile directory
  • additional_flags (List[str], optional): Extra Chromium flags
  • wait (bool, default=False): Wait for browser to exit
  • auto_profile (bool, default=True): Auto-generate isolated profile (keeps process alive)

Returns: subprocess.Popen - Browser process

Raises:

  • ChromiumNotFoundError: No browser found
  • ValueError: Invalid URL

Note: When auto_profile=True, each PWA gets its own isolated profile based on the URL hostname. This prevents Chrome from handing off to an existing instance and keeps your process alive.

check_pwa_support(url, timeout=10)

Check if a URL supports PWA features.

Parameters:

  • url (str): URL to check
  • timeout (int): Request timeout in seconds

Returns: PWACheckResult with:

  • is_pwa_supported (bool): Whether PWA is supported
  • has_manifest (bool): Has web manifest
  • manifest_url (str): URL of manifest file
  • manifest_data (dict): Parsed manifest data
  • has_service_worker (bool): Has service worker
  • service_worker_url (str): URL of service worker
  • has_https (bool): Uses HTTPS
  • errors (list): List of error messages
  • warnings (list): List of warnings

get_chromium_install()

Get a Chromium browser executable path from system-installed browsers.

Returns: Path - Path to Chromium executable

Raises: ChromiumNotFoundError - No browser found

get_chromium_installs()

Get all available Chromium browser executable paths from system.

Returns: List[Path] - List of paths to Chromium executables

Examples

See the examples/ directory for more examples:

  • examples/check_pwa.py - Check PWA support

Command Line Usage

Launch a PWA

python -m pwa_launcher.open_pwa https://weatherlite.app

Check PWA Support

python -m pwa_launcher.pwa_support https://weatherlite.app

How It Works

  1. Detect Browser: Searches for installed Chromium-based browsers on your system
  2. Build Command: Creates command with --app={url} and PWA flags
  3. Launch: Starts browser in app mode with PWA features enabled

PWA Flags Included

  • --app={url}: Launch in app mode (no browser UI)
  • --enable-features=WebAppInstallation: Enable PWA installation
  • --enable-features=DesktopPWAsTabStrip: Enable tab strip in PWAs
  • --enable-features=FileSystemAccessAPI: Enable file system access
  • --enable-features=NotificationTriggers: Enable notifications
  • --no-default-browser-check: Skip default browser check
  • --no-first-run: Skip first run experience
  • --disable-infobars: Remove automation banners
  • Linux only: --no-sandbox, --disable-gpu, --disable-dev-shm-usage

Development

Setup

# Clone the repository
git clone https://github.com/yourusername/py-pwa-launcher.git
cd py-pwa-launcher

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements-dev.txt

Run Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=pwa_launcher

# Run specific test file
pytest tests/test_open_pwa.py -v

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

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

Source Distribution

pwa_launcher-1.0.0.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

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

pwa_launcher-1.0.0-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file pwa_launcher-1.0.0.tar.gz.

File metadata

  • Download URL: pwa_launcher-1.0.0.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for pwa_launcher-1.0.0.tar.gz
Algorithm Hash digest
SHA256 23206a6b6d9a0f42ceaa1ff68a188152d8d8b82466c97d199e18ca594de4d2e6
MD5 98f1e708b8b19833058820fb7abc3337
BLAKE2b-256 5f72d424c6015d422c1a5941b1bba003d24cad26ae8237735d89d3cd15156068

See more details on using hashes here.

File details

Details for the file pwa_launcher-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pwa_launcher-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for pwa_launcher-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 252fcc35088ce44ef588bbd12038a2be58e3a880036b80d302d928ae53ec2243
MD5 75dee90310eafa1181d96ed174b119fd
BLAKE2b-256 336affc2d258df7f68b00d738855e418b819f10acdaf2bf3e78da65bdf97866e

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