Skip to main content

LLM-assisted high-res marketing screenshots for SaaS apps (generic login via Playwright storage_state).

Project description

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-llm enables multi-step navigation: the model sees a screenshot + accessibility tree each step and returns one action at a time until it says done.
  • --use-llm-crop asks 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.log on every run.
  • If the LLM repeats a previously failed action, it is automatically re-queried with a different approach.

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

shots-0.2.4.tar.gz (125.9 kB view details)

Uploaded Source

Built Distribution

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

shots-0.2.4-py3-none-any.whl (36.6 kB view details)

Uploaded Python 3

File details

Details for the file shots-0.2.4.tar.gz.

File metadata

  • Download URL: shots-0.2.4.tar.gz
  • Upload date:
  • Size: 125.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for shots-0.2.4.tar.gz
Algorithm Hash digest
SHA256 6a6eeaceb747d14f10c0c95a4e9dcfec8e34c5967526ea6d8996dd1a220efc8a
MD5 cfdcc395331b60912e2190b98b480293
BLAKE2b-256 c39dc0f66f3d5c24a1fbcf6cdb29ac69060263477873b442d2c237876e9be1ef

See more details on using hashes here.

Provenance

The following attestation bundles were made for shots-0.2.4.tar.gz:

Publisher: publish.yml on gaussian/shots

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shots-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: shots-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 36.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for shots-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2d29f54de558a48d751380a8e5cbda4b02ea444806636aa93e0e23fe43ffda17
MD5 19958dcc31b340d73440a4a1dea0dbc4
BLAKE2b-256 ec64fc442ce86bff12f47b51f18d0cccbb106e80b4ce04ca611e671f62ee4e91

See more details on using hashes here.

Provenance

The following attestation bundles were made for shots-0.2.4-py3-none-any.whl:

Publisher: publish.yml on gaussian/shots

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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