Skip to main content

Create Web Preview Images From url, Html-CSS ,svg, any other readable file or string.

Project description

HtmlWebShot

PyPI version Codacy Badge Licencse PyPI downloads

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

html = """<h1> Hello World </h1>
<p>Write something about the world.</p>"""
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

from htmlwebshot import WebShot
shot = WebShot()

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

html = """<h1> Hello World </h1>
<p>Write something about the world.</p>"""
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. sample1
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. sample2

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. sample4
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. sample3

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

Project details


Download files

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

Source Distribution

htmlwebshot-0.1.2.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

htmlwebshot-0.1.2-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file htmlwebshot-0.1.2.tar.gz.

File metadata

  • Download URL: htmlwebshot-0.1.2.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for htmlwebshot-0.1.2.tar.gz
Algorithm Hash digest
SHA256 76f517de8ae711d5f7abdfc53af1e9177473193244fe5f66d151a79e9a8153ac
MD5 9f8688b1162d49f1fd2a772e7285ba61
BLAKE2b-256 c52ec26fa86fab5139a433f2613e60f14aabb540d8e811991a4edb9b64200150

See more details on using hashes here.

File details

Details for the file htmlwebshot-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: htmlwebshot-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 21.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for htmlwebshot-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1b3dbfba07f437a834eadc82f15ead5c32a80efd7b01a8d4e6f7c035bc090f25
MD5 3b971cd98f0394f87fb50adaccf8bb30
BLAKE2b-256 e7aa511b7bea1693e623ffcf18cf094f903eac246267a38957ffa8630ce8920d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page