Skip to main content

Simple PDF generation for Python

Project description

build status Pypi latest version License: LGPL v3 codecov Downloads per month

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.

Contributors ✨

This library could only exist thanks to the dedication of many volunteers around the world:


Mariano Reingart

💻

David Ankin

🐛 💻 📖 🚧 💬 👀 ⚠️

Alex Pavlovich

🐛 💻 📖 💬 👀 ⚠️

Lucas Cimon

📝 💻 📖 🚇 🚧 💬

Miroslav Šedivý

💻 ⚠️

Florian Bernhart

💻 ⚠️

Edwood Ocasio

💻 ⚠️

Marcelo Duarte

💻

Roman Kharin

💻 🤔

Christopher Frost

🐛 💻

Michael Kalbermatten

🐛 💻

Yanone

💻

Leo Zhu

💻

Abishek Goda

💻

Arthur Moore

💻 ⚠️ 🐛

Bogdan Cuza

💻

Craig Hobbs

💻

xitrushiy

🐛 💻

José L. Redrejo Rodríguez

💻

Jürgen Gmach

💻

Larivact

💻

Leonel Câmara

💻

Mark Steadman

🐛 💻

Sergey

💻

Stan-C421

💻

Viraj Shah

💻

cornicis

💻

moe-25

💻 👀 🔬 🐛

Simone Bizzotto

💻

Boonyawe Sirimaha

🐛

T

💻

AubsUK

💬

This project follows the all-contributors specification (emoji key). Contributions of any kind welcome!

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.

Download files

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

Files for fpdf2, version 2.4.3
Filename, size File type Python version Upload date Hashes
Filename, size fpdf2-2.4.3-py2.py3-none-any.whl (124.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size fpdf2-2.4.3.tar.gz (77.6 kB) File type Source Python version None Upload date Hashes View

Supported by

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