Installation¶

Prerequisites¶

Python 3.11 or later -- Screenwright uses modern Python features including StrEnum, TypeVar bounds, and datetime.UTC.
pip -- The standard Python package installer.

Install Screenwright¶

pip install screenwright

This installs the core framework and its runtime dependencies (pyyaml and jinja2).

Verify the Installation¶

python -c "import screenwright; print(screenwright.__version__)"

You should see the installed version printed, for example:

0.1.0

Install with Test Dependencies¶

For writing and running BDD tests you will also need pytest and pytest-bdd. These are not bundled with Screenwright so that you can pin your own versions:

pip install pytest pytest-bdd

Install for Development¶

If you are contributing to Screenwright itself, install the development extras:

pip install screenwright[dev]

This adds pytest, pytest-bdd, pytest-cov, mutmut, ruff, mypy, and other development tools.

Install Documentation Dependencies¶

To build the documentation site locally:

pip install screenwright[docs]

This adds MkDocs Material and mkdocstrings so you can run mkdocs serve to preview the docs.