Skip to main content

Simple PDF generation for Python

Project description

build status Pypi latest version License: LGPL v3 codecov

Pull Requests Welcome first-timers-only Friendly -> come look at our good first issues

fpdf2

fpdf2 logo

fpdf2 is a minimalist PDF creation library for Python:

from fpdf import FPDF

document = FPDF()
document.add_page()
document.set_font('helvetica', size=12)
document.cell(txt="hello world")
document.output("hello_world.pdf")

It is a fork and the successor of PyFPDF. Compared with other PDF libraries, fpdf2 is simple, small and versatile, with advanced capabilities, and is easy to learn, extend and maintain.

Looking for Developer Help!

Installation Instructions:

pip install fpdf2

To get the latest development version:

# Linux only:
sudo apt-get install libjpeg-dev libpython-dev zlib1g-dev # libpython3.3-dev #(if necessary)

# Linux and Windows:
git clone https://github.com/PyFPDF/fpdf2.git
cd fpdf2
python setup.py install

Features:

  • Python 3.6+ support
  • Unicode (UTF-8) TrueType font subset embedding
  • Internal/External Links
  • PNG, GIF and JPG support (including transparency and alpha channel)
  • Shape, Line Drawing
  • Generate Code 39 & Interleaved 2 of 5 barcodes
  • Cell / multi-cell / plaintext writing, automatic page breaks
  • Basic conversion from HTML to PDF
  • Images & links alternative descriptions
  • Table of contents & document outline
  • Optional basic Markdown-like styling: **bold**, __italics__, --underlined--
  • Clean error handling through exceptions
  • Only one dependency so far: Pillow
  • Unit tests with qpdf-based PDF diffing

We validate all our PDF samples using 3 different checkers:

QPDF logo PDF Checker logo VeraPDF logo

Documentation:

You can also have a look at the tests/, they're great usage examples!

Developers:

Please check the documentation page dedicated to development.

This library was only possible thanks to the dedication of many volunteers around the world, listed in CONTRIBUTORS.md.

Contributors map

(screenshot from June 2021, click on the map above to access an up-to-date online version)

Other libraries

For alternatives, check out this detailed list of PDF-related Python libs by Patrick Maupin. There is also pikepdf, PyFPDF2 & WeasyPrint.

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

fpdf2-2.4.2.tar.gz (71.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fpdf2-2.4.2-py2.py3-none-any.whl (118.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file fpdf2-2.4.2.tar.gz.

File metadata

  • Download URL: fpdf2-2.4.2.tar.gz
  • Upload date:
  • Size: 71.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for fpdf2-2.4.2.tar.gz
Algorithm Hash digest
SHA256 4e4ff40a9f5a42d54d5336150afd78de18158301a4655e6e3713210253bf6c52
MD5 74a53627a60276578bdad75267b6bc0b
BLAKE2b-256 cc0ac878cd214263493e5251826fba05b30c9865ec1120bce258f8ac97dbe34f

See more details on using hashes here.

File details

Details for the file fpdf2-2.4.2-py2.py3-none-any.whl.

File metadata

  • Download URL: fpdf2-2.4.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 118.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for fpdf2-2.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 15b1c73740a6545f363f6f8bac1fc170da573b0527e4ed8ede06cb5fe37163b2
MD5 2c2fb6359b7a1ea4eaec4fdfb15eef84
BLAKE2b-256 2f8bc5e17479f8ad56e414bc936dcee6db509ad563bc80809fbcb6ba9279cee1

See more details on using hashes here.

Supported by

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