Skip to main content

A library for converting HTML files into PDF. The tool uses Chrome to render the HTML and print it into a pdf file.

Project description

Pdfy

DOI

Pdfy is a Python library for converting HTML (and anything Chrome can render) into PDF. It uses Chrome printing functionality, so the PDFs will be rendered exactly as printed in the browser.

Installation

To install the library, you need to run.

pip install pdfy

Additionally, you will need to install Chrome Driver.

Usage

Using the library is as easy as:

from pdfy import Pdfy
p = Pdfy()
p.html_to_pdf("html_file.htm", pdf_path="pdf_file.pdf")

More control over the PDF layout

If you need to have more control over the layout, you can pass additional parameters to html_to_pdf

options = {"paperWidth": 8.3, "paperHeight":11.7}
p.html_to_pdf("html_file.htm", pdf_path="pdf_file.pdf" options=options)

The full list of parameters is available on Chrome's Developer site.

Not saving the PDF

In the absence of the pdf_path argument, the html_to_pdf function will return the PDF as a base64 encoded string.

pdf = p.html_to_pdf("html_file.htm")

Multiple instances

The library will run Chrome in the background in the remote debug mode. This means that if your project requires multiple initialized Pdfy objects, you might need to change the port used for debugging. This can be done by passing the port number to Pdfy() as follows:

p = Pdfy(debug_port=9222) #9222 is the default port

Credits

This library is released under the Apache 2.0 License.

(C) Copyright 2018-2024 Mika Hämäläinen

Cite

@software{mika_hamalainen_2020_4108770,
  author       = {Mika Hämäläinen and
                  Hiromu Hota and
                  Mike and
                  Mirza Delic},
  title        = {mikahama/pdfy 1.0.50},
  month        = oct,
  year         = 2020,
  publisher    = {Zenodo},
  version      = {1.0.50},
  doi          = {10.5281/zenodo.4108770},
  url          = {https://doi.org/10.5281/zenodo.4108770}
}

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

pdfy-1.2.1.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

pdfy-1.2.1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file pdfy-1.2.1.tar.gz.

File metadata

  • Download URL: pdfy-1.2.1.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.3

File hashes

Hashes for pdfy-1.2.1.tar.gz
Algorithm Hash digest
SHA256 9e8d44d341d8ae404f0c91b7b68d73c5ca6f2473df634ab2c5a988c15467936a
MD5 e9764927ca7554e7942d0ff97580bbdf
BLAKE2b-256 0fd5c55f8a9f093d167e3ddeb94aa97861b64fdd2b515467563333bc3684b78d

See more details on using hashes here.

File details

Details for the file pdfy-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: pdfy-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.3

File hashes

Hashes for pdfy-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e43d97d2ed77ffe499f7f6b4b98afe87e7df7f2a8229f3ab924283ea781a2437
MD5 dc8b1334f691016389882bf789c95403
BLAKE2b-256 d5d81ff22b7639b88bb001e0d7509fb8506e0c44113d934d920c9f3accef9946

See more details on using hashes here.

Supported by

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