Skip to content

DanielMartinezSebastian/wshot

Repository files navigation

Wshot - Automated web screenshot tool

📸 Wshot

Automated web screenshot tool for multiple devices. Perfect for visual audits, responsive testing, and web project documentation.

🚀 Quick Installation

Method 1: Standard Installation (Recommended)

pip install wshot
playwright install chromium

Method 2: Isolated Installation (pipx)

pipx install wshot
pipx inject wshot playwright requests
playwright install chromium

Verify Installation

wshot --help
Install from source
pip install git+https://github.com/DanielMartinezSebastian/wshot.git
playwright install chromium
🔧 Installation Troubleshooting

pipx users: If you get dependency errors, inject the required packages:

pipx inject wshot playwright requests

Virtual environments: Always install in a virtual environment for isolation:

python -m venv wshot-env
source wshot-env/bin/activate  # Linux/Mac
# wshot-env\Scripts\activate     # Windows
pip install wshot
playwright install chromium

Installation issues? See DOCS.md or TROUBLESHOOTING.md

⚡ Basic Usage

# Capture on all devices
wshot https://example.com -all

# Specific device
wshot https://example.com --device mobile
wshot https://example.com --device desktop

# Super mode (recommended)
wshot https://example.com --super

See all commands and options in DOCS.md

📱 Main Devices

Device Dimensions Usage
mobile 393×852 iPhone 15 (mobile standard)
tablet 768×1024 iPad (tablet standard)
laptop 1280×800 13" Laptop (standard)
desktop 1920×1080 Full HD Monitor (standard)
desktop-4k 3840×2160 4K Professional Monitor

See complete list in DEVICES.md

📂 Output Structure

~/Pictures/WSHOT/
└── example.com/
    ├── mobile/
    │   ├── example.com_mobile-20241005_142958.png
    │   └── example.com_mobile-complete-20241005_142958.png
    └── desktop/
        ├── example.com_desktop-20241005_142958.png
        └── example.com_desktop-complete-20241005_142958.png

⚙️ Main Options

# All devices
wshot https://example.com -all

# Specific device
wshot https://example.com --device mobile

# Super mode (recommended for complex sites)
wshot https://example.com --super

# Custom wait time
wshot https://example.com --device desktop --wait-time 5

# Auto-dismiss cookie banners
wshot https://example.com --device desktop --auto-dismiss

# Extract OpenGraph metadata
wshot https://example.com --device desktop --og

# Open file explorer when finished
wshot https://example.com --super --open

📖 Help

wshot --help      # Quick help
wshot --info      # Complete guide

📚 Documentation

📄 License

MIT License - see LICENSE for details.

About

Automated web screenshot CLI for responsive testing, visual audits, and documentation. Capture full-page screenshots across multiple devices in seconds.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages