webshot 0.3.0

A command-line tool for automated website screenshots and web scraping
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# Example configuration file for webshot batch processing
# This demonstrates various features and options available

# Global defaults applied to all screenshots
defaults:
  width: 1280
  height: 800
  timeout: 30
  wait: 2
  retina: false
  user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
  output_dir: "screenshots"
  headers:
    "Accept-Language": "en-US,en;q=0.9"
  cookies:
    - name: "session"
      value: "example_session_id"
      domain: ".example.com"

# List of screenshots to take
screenshots:
  # Basic screenshot
  - url: "https://example.com"
    output: "example-homepage.png"

  # Custom viewport size
  - url: "https://github.com"
    output: "github-desktop.png"
    width: 1920
    height: 1080

  # Element-specific screenshot
  - url: "https://github.com"
    output: "github-header.png"
    selector: ".Header"

  # Mobile viewport
  - url: "https://example.com"
    output: "example-mobile.png"
    width: 375
    height: 812

  # Screenshot with JavaScript execution
  - url: "https://example.com"
    output: "example-interactive.png"
    javascript: |
      // Click a button or interact with the page
      document.querySelector('button')?.click();
      // Change some styling
      document.body.style.backgroundColor = '#f0f0f0';

  # Wait for dynamic content
  - url: "https://httpbin.org/delay/2"
    output: "httpbin-delayed.png"
    wait_for: "pre"
    timeout: 10

  # High-quality JPEG
  - url: "https://picsum.photos/1200/800"
    output: "random-image.jpg"
    quality: 95

  # Retina/high-DPI screenshot
  - url: "https://example.com"
    output: "example-retina.png"
    retina: true

  # PDF generation
  - url: "https://example.com"
    output: "example-page.pdf"

  # Custom headers and authentication
  - url: "https://httpbin.org/basic-auth/user/pass"
    output: "authenticated.png"
    auth:
      username: "user"
      password: "pass"
    headers:
      "X-Custom-Header": "webshot-example"

  # Screenshot with custom wait time and user agent
  - url: "https://httpbin.org/user-agent"
    output: "user-agent-test.png"
    wait: 3
    user_agent: "WebshotBot/1.0"

  # Multiple elements with different selectors
  - url: "https://github.com/explore"
    output: "github-explore-trending.png"
    selector: ".Box:first-child"
    wait_for: ".Box"

  # Long page screenshot (full height)
  - url: "https://github.com/features"
    output: "github-features-full.png"
    height: 2000

  # Screenshot with complex JavaScript
  - url: "https://example.com"
    output: "example-modified.png"
    javascript: |
      // Remove unwanted elements
      document.querySelectorAll('.advertisement, .popup').forEach(el => el.remove());
      
      // Modify content
      const title = document.querySelector('h1');
      if (title) {
        title.textContent = 'Modified by WebShot';
        title.style.color = 'red';
      }
      
      // Scroll to specific position
      window.scrollTo(0, 500);
      
      // Wait for any animations to complete
      await new Promise(resolve => setTimeout(resolve, 1000));

  # Screenshot with cookies for personalized content
  - url: "https://example.com"
    output: "example-personalized.png"
    cookies:
      - name: "user_preference"
        value: "dark_theme"
        path: "/"
      - name: "language"
        value: "en"
        path: "/"