HtmlWebShot - A python3 package which Can Create Images From url, Html-CSS, Svg and from any readable file and texts with many setup features.

Last update: Dec 14, 2022

Overview

HtmlWebShot

A python3 package which Can Create Images From url, Html-CSS, Svg and from any readable file and texts with many setup features.

Setup & Installation

Install HtmlWebShot:
```
$ pip3 install htmlwebshot
```

Install wkhtmltopdf:

Debian/Ubuntu:
```
$ apt-get install wkhtmltopdf -y  
```

MacOs:

$ brew install homebrew/cask/wkhtmltopdf

Alternative Support

$ wget https://github.com/1Danish-00/HtmlWebShot/raw/main/script.sh | sh

Win / Arch / Others
click here

Usage

Import & Instantiate

from htmlwebshot import WebShot
shot = WebShot()

Multiple Arguments

size: (int , int) : tuple : height, width default: full-screen
quality: int : between 1 to 100
delay: float : delay time in sec to load page
flags: list : know More
params: dict : know more
config: path setup know more

Simple Method

Using Url

shot.create_pic(url="https://google.com")

Using Html File

shot.create_pic(html="myfile.html", output="picture.jpg")

Using Html with CSS

via files

shot.create_pic(html="myfile.html", css="background.css", output="picture.jpg")

via string

Hello World

Write something about the world.

""" css = "body {background: pink;} p {color: red;}" shot.create_pic(html=html, css=css, output="picture.jpg") ">

html = """ Hello World 
Write something about the world.
"""
css = "body {background: pink;} p {color: red;}" 

shot.create_pic(html=html, css=css, output="picture.jpg")

Using Svg Or Any Other Readable File/Text

shot.create_pic(other="violin.svg", output="picture.jpg")

text = "What should I write here???"
shot.create_pic(other=text, size=(100,200))

You can use with async too

await shot.create_pic_async( # parameters are same for both

Some Examples

Hello World

Write something about the world.

""" css = "body {background: pink;} p {color: red;}" shot.create_pic(html=html, css=css, output="picture.jpg") ">

from htmlwebshot import WebShot
shot = WebShot()

shot.size = (110, 270)
shot.quality = 80  # maximum 100

html = """ Hello World 
Write something about the world.
"""
css = "body {background: pink;} p {color: red;}"

shot.create_pic(html=html, css=css, output="picture.jpg")

Click Here To See Output Image Of Above Code.

from htmlwebshot import WebShot
shot = WebShot()

shot.quality = 100
shot.params = {"--crop-x":300, "--crop-w": 400}

shot.create_pic(html="profile.html", css="profile.css")

Click Here To See Output Image Of Above Code.

Click For More Examples

from htmlwebshot import WebShot
shot = WebShot()

shot.quality = 85
shot.flags = ["--enable-javascript"]

shot.create_pic(html="jsgraph.html")

Click Here To See Output Image Of Above Code.

from htmlwebshot import WebShot
shot = WebShot()

shot.flags = ["--quiet"]
shot.quality = 100

shot.create_pic(other="violin.svg", size=(500,600))

Click Here To See Output Image Of Above Code.

Flags Uses

Click Here To Check All Flags:

--quiet: Be less verbose
--disable-smart-width: To force size to be accurate
--custom-header-propagation: Add HTTP headers specified by flag --custom-header for each resource request
--no-custom-header-propagation: Don't Add HTTP headers specified by flag --custom-header for each resource request
--disable-javascript: Don't allow web pages to run javascript
--enable-javascript: Allow web pages to run javascript
--proxy-hostname-lookup: Use the proxy for resolving hostnames
--stop-slow-scripts: Stop slow running javascripts
--no-stop-slow-scripts: Don't Stop slow running javascripts

from htmlwebshot import WebShot
shot = WebShot()
shot.flags = ["--quiet", "--enable-javascript", "--no-stop-slow-scripts"]

Available Params

Click Here To Check All Params options:

--bypass-proxy-for: Bypass proxy for host (repeatable)
--cookie: Set an additional cookie (repeatable), value should be url encoded.
--cookie-jar: Read and write cookies from and to the supplied cookie jar file
--crop-h: Set height for cropping
--crop-w: Set width for cropping
--crop-x: Set x coordinate for cropping
--crop-y: Set y coordinate for cropping
--custom-header: Set an additional HTTP header (repeatable)
--encoding: Set the default text encoding, for input
--format: Output file format
--minimum-font-size: Minimum font size
--password: HTTP Authentication password
--post: Add an additional post field (repeatable)
--post-file: Post an additional file (repeatable)
--proxy: Use a proxy
--run-script: Run this additional javascript after the page is done loading (repeatable)
--ssl-crt-path: Path to the ssl client cert public key in OpenSSL PEM format, optionally followed by intermediate ca and trusted certs
--ssl-key-password: Password to ssl client cert private key
--ssl-key-path: Path to ssl client cert private key in OpenSSL PEM format
--user-style-sheet: Specify a user style sheet, to load with every page
--username: HTTP Authentication username
--window-status: Wait until window.status is equal to this string before rendering page
--zoom: Use this zoom factor

from htmlwebshot import WebShot
shot = WebShot()
shot.params = {
    "--custom-header": "Accept-Encoding gzip",
    "--minimum-font-size": 50,
    "--format": "png",
    "--zoom": 10,
    }

Config Path

If you installed pkg directly then no need to configure it, It'll auto configure.
But If u installed externally then you have to setup config path.

from htmlwebshot import WebShot, Config
shot = WebShot()
shot.config = Config(wkhtmltopdf="/path/to/wkhtmltopdf", wkhtmltoimage="/path/to/wkhtmltoimage")

Comments

[BUG REPORT]: Query String on Local File Not Working
Your System?

Windows 10

Version

3.8

Version

latest

What happened?

When I try to take a screenshot of a local file whilst providing a URL query string, it does not work. My assumption is that it tried to look for a file which contains the query string in the filename.

Paste Your Codes.

shot.create_pic(html=r"folder\file.html?username=hi", css=r"folder\tweet.css", output="output.jpg")

Your Error Logs.

It does not output an error
bug
opened by i-vone 3
[BUG REPORT]:
Your System?

Ubuntu

Python Version

3.8

HtmlWebShot Version

latest

What happened?

Delay not working at all

Used Code.

//tried this shot.params = {"--javascript-delay": 5000} //and this shot.create_pic(html="file.html", delay=5, output="out.jpg", size=(1024,512)) //none worked?

Error Logs.

No response
bug
opened by asauce0972 1

A simple programme for converting url into a qr code (.png file)

QrTk A simple lightweight programme for converting url into a qr code (.png file) Pre-Requisites Before installing the programme , you need to run the

4 Nov 8, 2021

missing-pixel-filler is a python package that, given images that may contain missing data regions (like satellite imagery with swath gaps), returns these images with the regions filled.

Missing Pixel Filler This is the official code repository for the Missing Pixel Filler by SpaceML. missing-pixel-filler is a python package that, give

11 Jul 19, 2022

Snowfall - helpful image handling utils - abstracts various file and opencv and pil features into result oriented functions

snowfall helpful image handling utils - abstracts various file and opencv and pil features into result oriented functions usage examples: from image_h

2 Jan 9, 2022

This app finds duplicate to near duplicate images by generating a hash value for each image stored with a specialized data structure called VP-Tree which makes searching an image on a dataset of 100Ks almost instantanious

Offline Reverse Image Search Overview This app finds duplicate to near duplicate images by generating a hash value for each image stored with a specia

53 Nov 15, 2022

HtmlWebShot - A python3 package which Can Create Images From url, Html-CSS, Svg and from any readable file and texts with many setup features.

Related tags

Overview

HtmlWebShot

Setup & Installation

Usage

Import & Instantiate

Multiple Arguments

Simple Method

Hello World

Some Examples

Hello World

Flags Uses

Available Params

Config Path

You might also like...

A simple programme for converting url into a qr code (.png file)

missing-pixel-filler is a python package that, given images that may contain missing data regions (like satellite imagery with swath gaps), returns these images with the regions filled.

Snowfall - helpful image handling utils - abstracts various file and opencv and pil features into result oriented functions

Xmas-Tree-GIF-Tool - Convert any given animated gif file into an animation in GIFT CSV format

A collection of python scripts which help you programatically create PNGs or GIFs

A python based library to help you create unique generative images based on Rarity for your next NFT Project

📷 Python package and CLI utility to create photo mosaics.

Transfers a image file(.png) to an Excel file(.xlsx)

This app finds duplicate to near duplicate images by generating a hash value for each image stored with a specialized data structure called VP-Tree which makes searching an image on a dataset of 100Ks almost instantanious

Comments

[BUG REPORT]: Query String on Local File Not Working

Your System?

Version

Version

What happened?

Paste Your Codes.

Your Error Logs.

[BUG REPORT]:

Your System?

Python Version

HtmlWebShot Version

What happened?

Used Code.

Error Logs.

Releases(v0.1.0)

v0.1.0(Aug 7, 2021)

Owner

Danish

3D Model files and source code for rotating turntable. Raspberry Pi, DC servo and PWM modulator required.

利用近邻法的弱点实现图片缩小后变成另一张图

MaryJane is a simple MJPEG server written in Python.

Program designed to mass edit and watermark all photos in a directory

This Github Action automatically creates a GIF from a given web page to display on your project README

Using P5.js, Processing and Python to create generative art

Convert Image to ASCII Art

A tool for hiding data inside of images

Archive of the image generator stuff from my API

Python Image Optimizer Script

A suite of useful tools based on 3D interactivity in napari

Python script to generate vector graphics of an oriented lattice unit cell

Python library for ascii graphics

A ray tracing render implemented using Taichi language.

QR Generator using GUI with Tinker

An example which streams RGB-D images over spout.

DP2 graph edit codes.

The coolest python qrcode maker for small businesses.

Plots is a graph plotting app for GNOME.

A utility for quickly cropping large collections of images.