Skip to main content

PDF generation in python using wkhtmltopdf suitable for heroku

Project description

Build Status codecov.io PyPI Status license

PDF generation in python using wkhtmltopdf.

Wkhtmltopdf binaries are precompiled and included in the package making pydf easier to use, in particular this means pydf works on heroku.

Currently using wkhtmltopdf 0.12.4 (with patched qt).

Install

pip install python-pdf

(pydf was taken, but I guess python-pdf is a clearer name anyway.)

Basic Usage

import pydf
pdf = pydf.generate_pdf('<h1>this is html</h1>')
with open('test_doc.pdf', 'w') as f:
    f.write(pdf)

pdf = pydf.generate_pdf('www.google.com')
with open('google.pdf', 'w') as f:
    f.write(pdf)

API

generate_pdf(source, [**kwargs])

Generate a pdf from either a url or a html string.

After the html and url arguments all other arguments are passed straight to wkhtmltopdf

For details on extra arguments see the output of get_help() and get_extended_help()

All arguments whether specified or caught with extra_kwargs are converted to command line args with '--' + original_name.replace('_', '-').

Arguments which are True are passed with no value eg. just –quiet, False and None arguments are missed, everything else is passed with str(value).

Arguments:

  • source: html string to generate pdf from or url to get

  • quiet: bool

  • grayscale: bool

  • lowquality: bool

  • margin_bottom: string eg. 10mm

  • margin_left: string eg. 10mm

  • margin_right: string eg. 10mm

  • margin_top: string eg. 10mm

  • orientation: Portrait or Landscape

  • page_height: string eg. 10mm

  • page_width: string eg. 10mm

  • page_size: string: A4, Letter, etc.

  • image_dpi: int default 600

  • image_quality: int default 94

  • extra_kwargs: any exotic extra options for wkhtmltopdf

Returns string representing pdf

get_version()

Get version of pydf and wkhtmltopdf binary

get_help()

get help string from wkhtmltopdf binary uses -h command line option

get_extended_help()

get extended help string from wkhtmltopdf binary uses -H command line option

execute_wk(*args)

Low level function to call wkhtmltopdf, arguments are added to wkhtmltopdf binary and passed to subprocess with not processing.

Changelog

0.3

  • uprev wkhtmltopdf from 0.12.2 (beta) to 0.12.4.

  • code cleanup

0.21

  • correct permissions on wkhtmltopdf binary.

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

python-pdf-0.30.tar.gz (15.3 MB view details)

Uploaded Source

Built Distribution

python_pdf-0.30-py2.py3-none-any.whl (15.3 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file python-pdf-0.30.tar.gz.

File metadata

  • Download URL: python-pdf-0.30.tar.gz
  • Upload date:
  • Size: 15.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for python-pdf-0.30.tar.gz
Algorithm Hash digest
SHA256 637bea809dd3a2b1eb09c26ef5b08389e29183141bbc2b14958352ed672ad1bc
MD5 729e9a0dd5ed5bb3c89697678a4341ab
BLAKE2b-256 a0a368ad58d6103dd44083bbe4a6adf3518d29032d72ca74df354bd7584a9aae

See more details on using hashes here.

Provenance

File details

Details for the file python_pdf-0.30-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for python_pdf-0.30-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d430dd5a6ed37f2f5f43fca8ccbe5082677c8c3dbac461576480445be7161bb2
MD5 eec002b86f70d3e542a2691da1990885
BLAKE2b-256 dd9e606fd5bd18e99bdeebda1236d10286579064155dcdd3f88a8be93d034649

See more details on using hashes here.

Provenance

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