shots
Generic, open-source friendly tooling to capture high-res marketing screenshots of a SaaS app.
Key idea: you log in once manually; shots saves a Playwright storage_state.json. After that, it can run repeatedly headless, optionally guided by an LLM (vision) to navigate and/or crop.
Install
python -m venv .venv
source .venv/bin/activate
pip install -e ".[llm,yaml]"
playwright install chromium
Setup
cp shots.yaml.example shots.yaml # edit with your app's URL and shots
cp .env.example .env # add your OPENAI_API_KEY
Both shots.yaml and .env are gitignored.
1) One-time manual login
shots login --base-url https://your-app.example.com --out-dir shots_out
This writes shots_out/storage_state.json.
2) Run screenshots from a config
export OPENAI_API_KEY=...
shots run-config --config shots.yaml --use-llm --use-llm-crop --save-source
CLI flags
| Flag | Default | Description |
|---|---|---|
--config |
(required) | Path to YAML/JSON config file |
--out-dir |
from config, or shots_out |
Output directory (overrides config out_dir) |
--use-llm |
off | LLM-driven multi-step navigation |
--model |
gpt-5.2 |
OpenAI model for navigation/crop |
--use-llm-crop |
off | LLM picks a marketing-friendly crop rectangle |
--max-crop-retries |
2 |
Crop validation retry attempts |
--save-source |
off | Save uncropped source images alongside output |
--overwrite |
off | Force re-capture of all shots, ignoring per-shot overwrite settings |
--timeout-ms |
10000 |
Page-load / navigation timeout |
--action-timeout-ms |
5000 |
Timeout for clicks/typing (fail fast) |
--headed |
off | Show the browser window (debug) |
--viewport |
desktop |
Fallback viewport preset (desktop, laptop, tablet, mobile) |
--viewport-w, --viewport-h, --scale |
from preset | Override viewport dimensions |
--full-page |
from config/preset | Capture full scrollable page |
Config format (YAML)
Simple (flat shots list)
Each shot is auto-wrapped into its own group with output: png.
base_url: https://your-app.example.com
start: /app
out_dir: shots_out
defaults:
viewport_preset: desktop
full_page: true
max_nav_steps: 12
shots:
- id: dashboard-hero
description: >
Capture the main dashboard with KPI cards and a chart visible.
Close any modal, cookie banner, or tour overlay.
url: /app/dashboard
- id: integrations
description: >
Show Settings -> Integrations page listing available integrations.
viewport_preset: laptop
Groups (multi-shot PDFs, labels, folders)
Use groups instead of shots for more control. Each group produces either a single PNG or a multi-page PDF.
base_url: https://your-app.example.com
start: /app
out_dir: shots_out
defaults:
viewport_preset: desktop
full_page: true
max_nav_steps: 12
groups:
- id: hero-shots
output: png
shots:
- id: dashboard-hero
description: >
Capture the main dashboard.
url: /app/dashboard
- id: onboarding-deck
output: pdf
folder: onboarding
label: "{id} — {url}"
label_date: true
shots:
- id: step-1-welcome
description: Show the welcome screen.
url: /app/onboarding
- id: step-2-profile
description: Show the profile setup page.
url: /app/onboarding/profile
Config reference
| Field | Level | Description |
|---|---|---|
base_url |
top | (required) App base URL |
start |
top | Default start path (default: /) |
out_dir |
top | Output directory (default: shots_out, overridden by --out-dir) |
defaults.viewport_preset |
top | desktop | laptop | tablet | mobile |
defaults.full_page |
top | Capture full scrollable page |
defaults.max_nav_steps |
top | Max LLM navigation steps per shot (default: 12) |
defaults.overwrite |
top | Default overwrite behavior for all shots (default: false) |
shots |
top | Flat list of shots (cannot coexist with groups) |
groups |
top | List of shot groups (cannot coexist with shots) |
groups[].id |
group | (required) Group identifier |
groups[].output |
group | png (1 shot max) or pdf (multi-shot) |
groups[].folder |
group | Override output subfolder name (defaults to group id) |
groups[].label |
group | Label template applied to all shots ({id}, {url}, {title}) |
groups[].label_date |
group | Append UTC timestamp below label |
id |
shot | (required) Shot identifier |
description |
shot | (required) What to capture (used as LLM goal) |
url |
shot | Start URL for this shot (absolute or relative to base_url) |
viewport_preset |
shot | Override viewport for this shot |
viewport |
shot | Custom {width, height, scale} |
full_page |
shot | Override full-page capture for this shot |
label |
shot | Per-shot label override |
overwrite |
shot | If false (default), skip when output PNG already exists |
Notes
--use-llmenables multi-step navigation: the model sees a screenshot + accessibility tree each step and returns one action at a time until it saysdone.--use-llm-cropasks the model to choose a crop rectangle for marketing-friendly framing, with automatic validation and retry.- All navigation is kept same-origin as
base_url. - A detailed log is written to
<out_dir>/shots.logon every run. - If the LLM repeats a previously failed action, it is automatically re-queried with a different approach.
Release files for shots 0.2.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| shots-0.2.8.tar.gz | 36.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| shots-0.2.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 73.8 kB
Release files / shots-0.2.8.tar.gz
| Download URL | shots-0.2.8.tar.gz |
|---|---|
| Size | 36.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4dabeda1d358f7b64b3fb54a83d00b8fcb78c25d0ec58f5c9a52df02da6ff30e
|
|
BLAKE2b-256 checksum How to use checksums |
2e6fa213fd4b0531c42e142f0b067fe3d96f3dc97b6a5f1aa4d8555941a65a40
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 27, 2026.
Transparency logRelease files / shots-0.2.8-py3-none-any.whl
| Download URL | shots-0.2.8-py3-none-any.whl |
|---|---|
| Size | 37.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
57a733e117bb057639ec24c18824a8f2f587e63106890621503c6c80871d9545
|
|
BLAKE2b-256 checksum How to use checksums |
d1f1e84052967e5f7f0cb3a834261b8d3c60e4c71da7717d68ebbd97c6ed419e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 27, 2026.
Transparency log