html2image

You can pass lists to the screenshot() method parameters to perform batch operations.

Batching Patterns:

• One filename for multiple inputs: If save_as is a single string, outputs will be suffixed (e.g., ABC_0.png, ABC_1.png).
• Multiple filenames for multiple inputs: If save_as is a list, it maps 1:1 to the input list.
• Multiple resolutions: If size is a list, it applies different sizes to each item. If the list is shorter than the inputs, the last size is repeated.
• Applying CSS to multiple HTML inputs: You can pass a single CSS string to multiple HTML strings, or a list of CSS strings to match a list of HTML strings.

# Create three files from one filename (outputs ABC_0.png, ABC_1.png, ABC_2.png)
hti.screenshot(html_str=['A', 'B', 'C'], save_as='ABC.png')

# Create three files from different filenames (outputs A.png, B.png, C.png)
hti.screenshot(html_str=['A', 'B', 'C'], save_as=['A.png', 'B.png', 'C.png'])

# Multiple screenshots with different sizes
# If not enough sizes are given, the last size in the list will be repeated
hti.screenshot(
    html_str=['A', 'B', 'C', 'D'],
    size=[(100, 50), (100, 100), (50, 50)]
)

# Apply multiple CSS strings to multiple HTML strings
hti.screenshot(
    html_str=['A', 'B'],
    css_str=['body {background: red;}', 'body {font-size: 50px;}']
)

The screenshot() method is the primary way to generate images. It returns a list containing the file path(s) of the generated screenshot(s).

Supported Input Parameters:

• url: A URL string to capture.
• html_file: Path to an HTML file.
• css_file: Path to a CSS file.
• html_str: An HTML string.
• css_str: A CSS string.
• other_file: Path to other file types (e.g., .svg).

Optional Parameters:

• size: A 2-tuple (width, height) to override the instance default.
• save_as: A string or list of strings to specify the output filename(s).

from html2image import Html2Image
hti = Html2Image()

# URL to image
hti.screenshot(url='https://www.python.org', save_as='python_org.png')

# HTML & CSS strings to image
html = "<h1> Title </h1>" 
css = "body {background: red;}"
hti.screenshot(html_str=html, css_str=css, save_as='red_page.png')

# HTML & CSS files to image
hti.screenshot(html_file='page.html', css_file='style.css', save_as='page.png')

# Other files (e.g. SVG)
hti.screenshot(other_file='star.svg')

To use the package, import Html2Image and create an instance. You can configure several parameters during instantiation or update them on the instance later.

Constructor Arguments:

• browser: The browser to use. Options: 'chrome' (default) or 'edge'.
• browser_executable: Path or command to the specific browser executable.
• output_path: Folder where screenshots are saved. Defaults to the current working directory.
• size: A 2-tuple (width, height) for screenshot resolution. Defaults to (1920, 1080).
• temp_path: Path for temporary resources. Defaults to %TEMP%/html2image (Windows) or /tmp/html2image (Linux/MacOS).
• keep_temp_files: If True, temporary files in temp_path are not automatically removed. Defaults to False.

from html2image import Html2Image

# Basic instantiation
hti = Html2Image()

# Custom configuration
hti = Html2Image(size=(500, 200), browser='edge')

# Updating configuration after instantiation
hti.size = (500, 200)
hti.output_path = 'my_screenshot_folder'

These arguments configure the underlying Html2Image instance behavior, such as browser selection and file paths.

| Argument | Description | Example |
|----------|-------------|---------|
| `-h, --help` | Show the help message and exit. | `hti --help`  |
| `-o, --output-path PATH` | Directory to save screenshots. (Default: current working directory)| `hti --url example.com -o my_images/`  |
| `--browser BROWSER`| Browser to use. Choices: `chrome`, `chromium`, `google-chrome`, `google-chrome-stable`, `googlechrome`, `edge`, `chrome-cdp`, `chromium-cdp`. (Default: `chrome`)| `hti --url example.com --browser edge` |
| `--browser-executable EXECUTABLE_PATH` | Path to the browser executable. Auto-detected if not provided. | `hti --browser-executable /usr/bin/google-chrome-stable`|
| `--cdp-port PORT`  | CDP port for CDP-enabled browsers (e.g., `chrome-cdp`). (Default: library-dependent)| `hti --browser chrome-cdp --cdp-port 9222 --url example.com`  |
| `--temp-path TEMP_DIR_PATH` | Directory for temporary files. (Default: system temp directory in an `html2image` subfolder)  | `hti --html-file page.html --temp-path /my/tmp`|
| `--keep-temp-files`| Do not delete temporary files after screenshot generation.| `hti --html-file page.html --keep-temp-files`  |
| `--custom-flags [FLAG ...]` | Custom flags to pass to the browser (e.g., `'--no-sandbox' '--disable-gpu'`). If provided, these flags will be used. | `hti --url example.com --custom-flags '--no-sandbox' '--disable-gpu'` <br> `hti --url example.com --custom-flags '--no-sandbox --disable-gpu'` |