html2image Library

2.0.7 · active · verified Tue Apr 14

The html2image package provides a Pythonic wrapper around headless web browsers (Chrome, Chromium, Edge, Firefox) to convert URLs, HTML strings, or HTML files (with CSS) into images. It's actively maintained with frequent updates, currently at version 2.0.7, focusing on browser compatibility and feature enhancements.

Warnings

gotcha The `html2image` library requires a compatible headless web browser (Chrome, Chromium, Edge, or Firefox) to be installed on your system. It does not automatically install one. Ensure your chosen browser is in your system's PATH, or provide its executable path via the `executable_path` parameter during initialization.
Fix: Install a supported browser (e.g., `sudo apt-get install chromium-browser` on Debian/Ubuntu) or set `Html2Image(executable_path='/path/to/browser')`.
breaking Version 2.0.0 introduced significant internal structural changes and revamped how browser flags are handled. Custom browser configurations or direct manipulation of browser arguments from pre-2.0.0 versions might require updates.
Fix: Review the `html2image` README and documentation for version 2.0.0+ regarding browser configuration and flags. Use the `browser_args` parameter for custom arguments.
breaking Starting with version 2.0.5, `html2image` defaults to using Chrome's `--headless=new` flag for improved compatibility with newer browser versions. If you encounter issues with older browser versions or specific environments, you might need to revert to the old headless mode.
Fix: For versions 2.0.5 and later, try initializing with `Html2Image(force_old_headless_mode=True)` or `Html2Image(browser_args=['--headless=old'])` if `headless=new` causes problems.
deprecated Version 2.0.3 fixed an issue where the default background color flag for Chrome/Chromium changed from '0' to '000000'. If you were relying on the '0' value, it might no longer be supported on newer Chromium versions.
Fix: Update any code setting the background color flag to use '000000' instead of '0'.
gotcha Version 2.0.2 was yanked from PyPI shortly after its release due to a problematic wheel file. Avoid installing or using this specific version.
Fix: Always install `html2image` version 2.0.3 or later to ensure stability and avoid known issues.
gotcha Version 2.0.7 introduced a new and improved Command Line Interface (CLI). Existing shell scripts or automation relying on the `html2image` command-line utility might need updates to match the new argument structure and syntax.
Fix: Consult the latest `html2image` documentation or run `html2image --help` to understand the updated CLI arguments and options.

Install

pip install html2image Install `html2image`

Imports

Html2Image
```
from html2image import Html2Image
```

Quickstart

This quickstart demonstrates how to initialize `Html2Image` and use it to capture screenshots from both a URL and an HTML string. Remember that a compatible headless browser must be installed on your system for `html2image` to function.

from html2image import Html2Image
import os

# Ensure you have a headless browser (Chrome, Chromium, Edge, or Firefox) installed
# For example, on Ubuntu:
# sudo apt-get update
# sudo apt-get install chromium-browser

hti = Html2Image(size=(1920, 1080), browser='chrome')

# Take a screenshot of a website
hti.screenshot(
    url='https://www.python.org',
    save_as='python_org.png',
    # You can specify a custom executable path if the browser isn't in PATH
    # executable_path='/usr/bin/chromium-browser'
)
print("Screenshot of python.org saved as python_org.png")

# Take a screenshot of an HTML string
html_content = """
<h1 style="color: blue;">Hello, `html2image`!</h1>
<p>This is a test of string conversion.</p>
"""
hti.screenshot(html_str=html_content, save_as='hello_html.png')
print("Screenshot of HTML string saved as hello_html.png")

# Clean up generated files for demonstration
# os.remove('python_org.png')
# os.remove('hello_html.png')

view raw JSON →