Skip to main content

Wkhtmltopdf wrapper

Project description


A simple python wrapper for wkhtmltopdf forked from python-wkhtmltopdf



  • Linux 32/64 or OSX only (Windows is not supported at this stage)
  • Xvfd
  • wkhtmltopdf
  • python 2.5+


wkhtmltopdf (Linux)

  1. Install Xvfd:

    $ sudo apt-get install xvfb
  2. Install Fonts:

    $ sudo apt-get install xfonts-100dpi xfonts-75dpi xfonts-scalable xfonts-cyrillic
  3. Install wkhtmltopdf:

    $ sudo apt-get install wkhtmltopdf

wkhtmltopdf (OSX)

  1. Install wkhtmltopdf:

    $ brew install wkhtmltopdf

python-wkhtmltopdf (Any Platform)

  1. Development:

    $ git clone
    $ cd html2pdf
    $ virtualenv .
    $ pip install -r requirements.pip
  2. PIP:

    $ pip install git+
    or from pypi
    $ pip install html2pdf


Simple Usage::

  1. Render a URL:

    from wkhtmltopdf import HTMLURLToPDF
    make_pdf = HTMLURLToPDF(
  2. Render a HTML string:

    from html2pdf import HTMLToPDF
    HTML = """
        <!DOCTYPE html>
            <h1>Hello World</h1>
    h = HTMLToPDF(HTML, self.output_file)

Required Arguments:

  • url - the url to convert to pdf
  • output_file - the pdf file that you want to create

Optional Arguments:

  • enable-plugins (default: True)
  • disable-javascript (default: False)
  • no-background (default: False)
  • grayscale (default: False)
  • orientation (default: Portrait)
  • dpi (default: 100)
  • username (default: None)
  • password (default: None)
  • margin-bottom (default: 10)
  • margin-top (default: 10)
  • margin-left (default: 10)
  • margin-right (default: 10)
  • disable-smart-shrinking (default: False)


Forked from wkhtmltopdf - Jonathan Bydendyk (

Project details

Release history Release notifications | RSS feed

This version


Download files

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

Source Distribution

html2pdf-0.1.tar.gz (5.1 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page