Write the test.
Get the demo.

A narration layer for Playwright. The test that checks a flow in your suite also walks a viewer through it, with caption cards, spotlights, and a drawn cursor.

pip install "playwright-limelight[django,pytest]"

One test, two runs

A plain pytest run skips the narration and checks the flow. Set DEMO_MODE=narrate and the same test plays as a demo.

Silent pytest

1 passed

Narrated DEMO_MODE=narrate pytest --headed

1 passed

Rendered, not recorded

A screen recording drops frames when the machine falls behind. A limelight render waits for each frame, so the video is smooth on any machine.

Recorded

Rendered

Each dot is one frame of a cursor crossing the screen. A hollow dot is a frame the recording repeated.

One run, one folder

A narrated run fills one folder per demo, and limelight-render turns it into each format you ship.

video.mp4
The demo as a video.
video.gif
A GIF for the README.
walkthrough.md
The steps written out for the docs.
01-orders.png
A screenshot of each step you mark.
render.mp4
The video with subtitles and your voiceover.
subtitles.vtt
The captions as subtitles.
chapters.txt
A chapter list from the title cards.
transcript.json
The timeline the rest is built from.

What comes with it

The demo never goes stale
The demo runs in CI with the rest of your tests, so a change that breaks it fails the build. A rerun renders a fresh video, with nothing to re-record.
A live demo stays on script
A present run drives the app and waits for a key press at each step, so you talk while the test clicks.
The test still catches bugs
A console error or an uncaught exception fails the test, and a failed run keeps a screenshot and a trace.
The voiceover keeps time
Each caption holds for as long as its spoken line, so your voiceover stays in step with the video.
Start from your tests
Wrap the page of an existing Playwright test in a Demo and add captions one line at a time. The rest of the test stays as it is.
Django is built in
The Django adapter signs a user in and finds each route by name. The static adapter drives any site that is already running.

Put a test in the limelight

pip install "playwright-limelight[django,pytest]"
  1. Fetch a browser

    Run playwright install chromium. A video render also needs ffmpeg on the PATH.

  2. Register the plugins

    Add limelight.pytest_plugin to pytest_plugins in conftest.py. A Django project adds limelight.django.pytest_plugin as well.

  3. Run it narrated

    Write the demo as a test, then run it with DEMO_MODE=narrate and --headed.

The package needs Python 3.11 and Playwright 1.49 or newer. The guides cover scenes, components, barriers, and configuration, and the API reference documents each module.