Package acting as a wrapper around the headless mode of existing web browsers to generate images from URLs and from HTML+CSS strings or files.

These details have not been verified by PyPI

Project links

Project description

HTML 2 Image

HTML2Image (HTML to Image) is a lightweight Python package that acts as a wrapper around the headless mode of existing web browsers to generate images from URLs and from HTML+CSS strings or files.

HTML2Image is currently in a work in progress stage.

Principle

Most web browsers have a Headless Mode, which is a way to run them without displaying any graphical interface. Headless mode is mainly used for automated testings but also comes in handy if you want to take screenshots of web pages that are exact replicas of what you would see on your screen if you were using the browser yourself.

However, for the sake of taking screenshots, headless mode is not very convenient to use. HTML2Image aims to hide the inconveniences of the browsers' headless modes while adding useful features such as allowing to create an image from as little as a string.

For more information about headless modes :

Installation

html2image is published on PyPI and can be obtained through pip or your favorite package manager :

pip install html2image

Usage

Import the library and instantiate it

from html2image import HtmlToImage
hti = HtmlToImage()

Possible arguments for the constructor :

browser : Browser that will be used, set by default to 'chrome' (the only browser supported by HTML2Image at the moment)
chrome_path and firefox_path : The path or the command that can be used to find the .exe of a specific browser. For now, start chrome is the default value of chrome_path.
output_path : Path to the folder to which taken screenshots will be outputed. Default is the current working directory of your python program.
size : 2-Tuple reprensenting the size of the screenshots that will be taken. Default value is (1920, 1080).
temp_path : Path that will be used by HTML2Image put together the different resources . Default value is the path in the %TEMP% user variable on windows (type echo %TEMP% in a command prompt to see it).

You can also modify these values afterward by accessing the attribute of the same name :

hti.size = (500, 200)

Image from an URL

The following code takes a screenshot (with a size of 800 * 400 ) of the python.org webpage and save it in the current working directory as python_org.png :

hti.size = (800, 400)
hti.screenshot_url('https://www.python.org', 'python_org.png')

# one line alternative :
hti.screenshot_url('https://www.python.org', 'python_org.png', size=(800, 400))

Result :

blue_screenshot

Image from HTML and CSS strings

The following code generates an image from two given strings, an HTML one and a CSS one.

...

# minimal html : quite unconventional but browsers can read it anyway
my_html_string = """\
<link rel="stylesheet" href="red_background.css">
<h1> An interesting title </h1>
This page will be red
"""

my_css_string = "body { background: red; }"

# image from html & css string
hti.load_str(my_html_string, as_filename='red_page.html')
hti.load_str(my_css_string, as_filename='red_background.css')

hti.screenshot('red_page.html', 'red.png')

Result (using size=(500, 200)):

blue_screenshot

Image from HTML and CSS files

/* blue_background.css */
body {
    background: blue;
}

<!-- blue_page.html -->
<!doctype html>
<html>
<head>
    <link rel="stylesheet" href="blue_background.css">
</head>

<body>
    <h1> An interesting title </h1>
    This page will be blue
</body>
</html>

...

# image from html & css files
hti.load_file('blue_page.html')
hti.load_file('blue_background.css')

hti.screenshot('blue_page.html', 'blue.png')

Result (using size=(500, 200)):

blue_screenshot

TODO List

A nice CLI
Suport of other browsers, such as Firefox
More extensive doc + comments
Deep search for the browsers executables?
PDF generation?

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

2.0.5

Sep 9, 2024

2.0.4.3

Aug 16, 2023

2.0.4.2

Aug 15, 2023

2.0.4.1

Aug 15, 2023

2.0.4

Aug 14, 2023

2.0.3

Mar 21, 2023

2.0.2 yanked

Mar 13, 2023

Reason this release was yanked:

Wrong wheel released on pypi

2.0.1

Jul 5, 2021

2.0.0

Jun 30, 2021

1.1.3

Jun 16, 2021

1.1.2

Apr 30, 2021

1.1.1

Dec 10, 2020

1.1.0

Nov 27, 2020

1.0.0

Nov 25, 2020

0.1.6

Oct 10, 2020

0.1.4

Aug 24, 2020

This version

0.1.3

Aug 21, 2020

0.1.2

Aug 8, 2020

0.1.1

Aug 8, 2020

0.1.0

Aug 7, 2020

0.1.0a1 pre-release

Aug 5, 2020

0.1.0a0 pre-release

Aug 5, 2020

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

html2image-0.1.3.tar.gz (7.4 kB view details)

Uploaded Aug 21, 2020 Source

Built Distribution

html2image-0.1.3-py3-none-any.whl (7.6 kB view details)

Uploaded Aug 21, 2020 Python 3

File details

Details for the file html2image-0.1.3.tar.gz.

File metadata

Download URL: html2image-0.1.3.tar.gz
Upload date: Aug 21, 2020
Size: 7.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.0.10 CPython/3.8.2 Windows/10

File hashes

Hashes for html2image-0.1.3.tar.gz
Algorithm	Hash digest
SHA256	`b7594b0a078126a6441b263fc77f2d75705362ede30cd74b933742ad63b43aa9`
MD5	`7b9eac38b0be69687ddf3510f161f847`
BLAKE2b-256	`35dea00dd7f959d6386185beae543f96c5b17a684e7db5d314c7c8297c152f12`

See more details on using hashes here.

File details

Details for the file html2image-0.1.3-py3-none-any.whl.

File metadata

Download URL: html2image-0.1.3-py3-none-any.whl
Upload date: Aug 21, 2020
Size: 7.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.0.10 CPython/3.8.2 Windows/10

File hashes

Hashes for html2image-0.1.3-py3-none-any.whl
Algorithm	Hash digest
SHA256	`f604104315182c44c86039b63ed8713dad9b7bbee06776d63d63563917c84411`
MD5	`8a891be694d985d1e6837c9cef5cae55`
BLAKE2b-256	`315e6478ab0e6db307595f92a31d9e9505ac8c81b0f090d804a7e61e46d844c9`