Package: pdfkit
Python 2 and 3 wrapper for wkhtmltopdf utility to convert HTML to PDF using Webkit.This is adapted version ofruby PDFKitlibrary, so big thanks to them!InstallationInstall python-pdfkit:$ pip install pdfkit  (or pip3 for python3)Install wkhtmltopdf:Debian/Ubuntu:$ sudo apt-get install wkhtmltopdfmacOS:$ brew install homebrew/cask/wkhtmltopdfWarning!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 usethis script.Windows and other options: check wkhtmltopdfhomepagefor binary installersUsageFor simple tasks:import pdfkit

pdfkit.from_url('http://google.com', 'out.pdf')
pdfkit.from_file('test.html', 'out.pdf')
pdfkit.from_string('Hello!', 'out.pdf')You can pass a list with multiple URLs or files:pdfkit.from_url(['google.com', 'yandex.ru', 'engadget.com'], 'out.pdf')
pdfkit.from_file(['file1.html', 'file2.html'], 'out.pdf')Also you can pass an opened file:with open('file.html') as f:
    pdfkit.from_file(f, 'out.pdf')If you wish to further process generated PDF, you can read it to a variable:# Without output_path, PDF is returned for assigning to a variable
pdf = pdfkit.from_url('http://google.com')You can specify all wkhtmltopdfoptions. 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 = {
    'page-size': 'Letter',
    'margin-top': '0.75in',
    'margin-right': '0.75in',
    'margin-bottom': '0.75in',
    'margin-left': '0.75in',
    'encoding': "UTF-8",
    'custom-header': [
        ('Accept-Encoding', 'gzip')
    ],
    'cookie': [
        ('cookie-empty-value', '""')
        ('cookie-name1', 'cookie-value1'),
        ('cookie-name2', 'cookie-value2'),
    ],
    'no-outline': None
}

pdfkit.from_url('http://google.com', 'out.pdf', options=options)By default, PDFKit will runwkhtmltopdfwithquietoption turned on, since in most cases output is not needed and can cause excessive memory usage and corrupted results. If need to getwkhtmltopdfoutput you should passverbose=Trueto API calls:pdfkit.from_url('google.com', 'out.pdf', verbose=True)Due to wkhtmltopdf command syntax,TOCandCoveroptions must be specified separately. If you need cover before TOC, usecover_firstoption:toc = {
    'xsl-style-sheet': 'toc.xsl'
}

cover = 'cover.html'

pdfkit.from_file('file.html', options=options, toc=toc, cover=cover)
pdfkit.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.WarningThis is a workaround forthis bugin wkhtmltopdf. You should try–user-style-sheetoption first.# Single CSS file
css = 'example.css'
pdfkit.from_file('file.html', options=options, css=css)

# Multiple CSS files
css = ['example.css', 'example2.css']
pdfkit.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="pdfkit-page-size" content="Legal"/>
        <meta name="pdfkit-orientation" content="Landscape"/>
      </head>
      Hello World!
      </html>
    """

pdfkit.from_string(body, 'out.pdf') #with --page-size=Legal and --orientation=LandscapeConfigurationEach API call takes an optional configuration paramater. This should be an instance ofpdfkit.configuration()API call. It takes the configuration options as initial paramaters. The available options are:wkhtmltopdf- the location of thewkhtmltopdfbinary. By defaultpdfkitwill attempt to locate this usingwhich(on UNIX type systems) orwhere(on Windows).meta_tag_prefix- the prefix forpdfkitspecific meta tags - by default this ispdfkit-Example - for whenwkhtmltopdfis not on$PATH:config = pdfkit.configuration(wkhtmltopdf='/opt/bin/wkhtmltopdf')
pdfkit.from_string(html_string, output_file, configuration=config)Also you can useconfiguration()call to check if wkhtmltopdf is present in$PATH:try:
  config = pdfkit.configuration()
  pdfkit.from_string(html_string, output_file)
except OSError:
  #not present in PATHTroubleshootingDebugging issues with PDF generationIf you struggling to generate correct PDF firstly you should checkwkhtmltopdfoutput for some clues, you can get it by passingverbose=Trueto API calls:pdfkit.from_url('http://google.com', 'out.pdf', verbose=True)If you are getting strange results in PDF or some option looks like its ignored you should try to runwkhtmltopdfdirectly to see if it produces the same result. You can get CLI command by creatingpdfkit.PDFKitclass directly and then calling itscommand()method:import pdfkit

r = pdfkit.PDFKit('html', 'string', verbose=True)
print(' '.join(r.command()))
# try running wkhtmltopdf to create PDF
output = r.to_pdf()Common errors:IOError: 'No wkhtmltopdf executable found':Make sure that you have wkhtmltopdf in your$PATHor set via custom configuration (see preceding section).where wkhtmltopdfin Windows orwhich wkhtmltopdfon Linux should return actual path to binary.IOError: 'Command Failed'This error means that PDFKit 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 wkhtmltopdf versions this can be cause by segmentation faults)Changelog1.0.0By default PDFKit now passes “quiet” option to wkhtmltopdf. Now if you need to get output you should pass “verbose=True” to API callsFix different issues with searching for wkhtmltopdf binaryUpdate error handling for wkhtmltopdfFix different issues with options handlingBetter handling of unicode inputSwitch from Travis to GitHub ActionsUpdate README0.6.1Fix regression on python 3+ when trying to decode pdf output0.6.0Support repeatable optionsSupport multiple values for some optionsFix some corner cases when specific argument order is requiredSome Python 3+ compatibility fixesUpdate README0.5.0Allow passing multiple css filesFix problems with external file encodingsRise an error when X server is missing on *nix systemsFix tests that was broken with latest wkhtmltopdf releaseUpdate README0.4.1More easier custom configuration settingUpdate README0.4.0Allow passing file-like objectsAbility to return PDF as a stringAllow user specification of configurationAPI calls now returns True on successbugfixes0.3.0Python 3 support0.2.4Add HistoryUpdate setup.py0.2.3Fix installing with setup.pyUpdate README