Package: imgkit
IMGKit: Python library of HTML to IMG wrapper_____   __  __    _____   _  __  _   _
 |_   _| |  \/  |  / ____| | |/ / (_) | |
   | |   | \  / | | |  __  | ' /   _  | |_
   | |   | |\/| | | | |_ | |  <   | | | __|
  _| |_  | |  | | | |__| | | . \  | | | |_
 |_____| |_|  |_|  \_____| |_|\_\ |_|  \__|Python 2 and 3 wrapper for wkhtmltoimage utility to convert HTML to IMG using Webkit.InstallationInstall imgkit:pipinstallimgkitInstall wkhtmltopdf:Debian/Ubuntu:sudoapt-getinstallwkhtmltopdfWarning!Version in debian/ubuntu repos have reduced functionality (because it compiled without the wkhtmltopdf QT patches), such as adding outlines, headers, footers, TOC etc. To use this options you should install static binary fromwkhtmltopdfsite or you can use thisscript.MacOSX:brewinstall--caskwkhtmltopdfWindows and other options:Checkwkhtmltopdf homepagefor binary installers orwiki page.UsageSimple example:importimgkitimgkit.from_url('http://google.com','out.jpg')imgkit.from_file('test.html','out.jpg')imgkit.from_string('Hello!','out.jpg')Also you can pass an opened file:withopen('file.html')asf:imgkit.from_file(f,'out.jpg')If you wish to further process generated IMG, you can read it to a variable:# Use False instead of output path to save pdf to a variableimg=imgkit.from_url('http://google.com',False)You can find all wkhtmltoimage options by typewkhtmltoimagecommand or visit thisManual. You can drop '--' in option name. If option without value, useNone, Falseor''for dict value:. For repeatable options (incl. allow, cookie, custom-header, post, postfile, run-script, replace) you may use a list or a tuple. With option that need multiple values (e.g. --custom-header Authorization secret) we may use a 2-tuple (see example below).options={'format':'png','crop-h':'3','crop-w':'3','crop-x':'3','crop-y':'3','encoding':"UTF-8",'custom-header':[('Accept-Encoding','gzip')],'cookie':[('cookie-name1','cookie-value1'),('cookie-name2','cookie-value2'),],'no-outline':None}imgkit.from_url('http://google.com','out.png',options=options)At some headless servers, perhaps you need to installxvfb:# at ubuntu server, etc.sudoapt-getinstallxvfb# at centos server, etc.yuminstallxorg-x11-server-XvfbThen useIMGKitwith optionxvfb:{"xvfb": ""}.By default, IMGKit will show allwkhtmltoimageoutput. If you don't want it, you need to passquietoption:options={'quiet':''}imgkit.from_url('google.com','out.jpg',options=options)Due to wkhtmltoimage command syntax,TOCandCoveroptions must be specified separately. If you need cover before TOC, usecover_firstoption:toc={'xsl-style-sheet':'toc.xsl'}cover='cover.html'imgkit.from_file('file.html',options=options,toc=toc,cover=cover)imgkit.from_file('file.html',options=options,toc=toc,cover=cover,cover_first=True)You can specify external CSS files when converting files or strings usingcssoption.# Single CSS filecss='example.css'imgkit.from_file('file.html',options=options,css=css)# Multiple CSS filescss=['example.css','example2.css']imgkit.from_file('file.html',options=options,css=css)You can also pass any options through meta tags in your HTML:body="""<html><head><meta name="imgkit-format" content="png"/><meta name="imgkit-orientation" content="Landscape"/></head>Hello World!</html>"""imgkit.from_string(body,'out.png')ConfigurationEach API call takes an optional config paramater. This should be an instance ofimgkit.config()API call. It takes the config options as initial paramaters. The available options are:wkhtmltoimage- the location of thewkhtmltoimagebinary. By defaultimgkitwill attempt to locate this using which(on UNIX type systems) or where(on Windows).xvfb- the location of thexvfb-runbinary. By defaultimgkitwill attempt to locate this using which(on UNIX type systems) or where(on Windows).meta_tag_prefix- the prefix forimgkitspecific meta tags - by default this isimgkit-Example - for whenwkhtmltopdforxvfbis not in$PATH:config=imgkit.config(wkhtmltoimage='/opt/bin/wkhtmltoimage',xvfb='/opt/bin/xvfb-run')imgkit.from_string(html_string,output_file,config=config)TroubleshootingIOError: 'No wkhtmltopdf executable found':Make sure that you have wkhtmltoimage in your$PATHor set via custom configuration (see preceding section).where wkhtmltoimagein Windows orwhich wkhtmltoimageon Linux should return actual path to binary.IOError: 'No xvfb executable found':Make sure that you have xvfb-run in your$PATHor set via custom configuration (see preceding section).where xvfbin Windows orwhich xvfb-runorwhich Xvfbon Linux should return actual path to binary.IOError: 'Command Failed':This error means that IMGKit was unable to process an input. You can try to directly run a command from error message and see what error caused failure (on some wkhtmltoimage versions this can be cause by segmentation faults)Creditpython PDFKitIMGKit authorjarrekkhttps://github.com/jarrekkContributorsv-hunthttps://github.com/v-huntarchydeberkerhttps://github.com/archydeberkerarayatehttps://github.com/arayatextrntrhttps://github.com/xtrntrmike1703https://github.com/mike1703themeewahttps://github.com/themeewaChange logGo tohttps://github.com/jarrekk/imgkit/wiki/CHANGE-LOG.