fpdf2

fpdf2 is a PDF creation library for Python:

from fpdf import FPDF

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

It is a fork and the successor of PyFPDF (cf. history). Compared with other PDF libraries, fpdf2 is fast, versatile, easy to learn and to extend (example). It is also entirely writen in Python and has very few dependencies: Pillow, defusedxml & svg.path.

Development status: this project is mature and actively maintained.

We are looking for contributing developers: if you want to get involved but don't know how, or would like to volunteer helping maintain this lib, open a discussion!

Installation Instructions

pip install fpdf2

To get the latest, unreleased, development version straight from the development branch of this repository:

pip install git+https://github.com/PyFPDF/fpdf2.git@master

Features

Python 3.7+ support
Unicode (UTF-8) TrueType font subset embedding
Internal / external links
Embedding images, including transparency and alpha channel
Arbitrary path drawing and basic SVG import
Embedding barcodes, charts & graphs, emojis, symbols & dingbats
Cell / multi-cell / plaintext writing, with automatic page breaks, line break and text justification
Choice of measurement unit, page format & margins. Optional page header and footer
Basic conversion from HTML to PDF
A templating system to render PDFs in batchs
Images & links alternative descriptions, for accessibility
Table of contents & document outline
Document signing
Annotations, including text highlights, and file attachments
Presentation mode with control over page display duration & transitions
Unit tests with qpdf-based PDF diffing and a high code coverage
Optional basic Markdown-like styling: **bold**, __italics__
Can render mathematical equations & charts
Usage examples with Django, Flask, streamlit, AWS lambdas... : Usage in web APIs

Our 300+ reference PDF test files, generated by fpdf2, are validated using 3 different checkers:

Please show the value

Choosing a project dependency can be difficult. We need to ensure stability and maintainability of our projects. Surveys show that GitHub stars count play an important factor when assessing library quality.

⭐ Please give this repository a star. It takes seconds and will help your fellow developers! ⭐

Please share with the community

This library relies on community interactions. Please consider sharing a post about fpdf2 and the value it provides 😊

Documentation

Documentation Home
Tutorial in several languages: English - Deutsch - español - हिंदी português - Русский - Italian - français - Ελληνικά
Release notes: CHANGELOG.md
A series of blog posts: fpdf2 tag @ ludochaordic

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

Developement

Please check the dedicated documentation page.

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 💬	_{Georg Mischler} 🐛 💻 🎨 📖 🤔 💬 ⚠️	_ping 🐛	_Portfedh 📖 ✅
_Tabarnhack 💻	_{Mridul Birla} 🌍	_digidigital 🌍	_Xit 🌍	_{Alexander Burchenko} 🌍	_{André Assunção} 🌍	_{Quentin Brault} 🌍
_{Paula Campigotto} 🐛 💻 👀	_{bettman-latin} 💻	_{oleksii-shyman} 💻 🎨 🤔	_lcomrade 📖 🐛 💻	_pwt 🐛 💻	_{Martin Cerveny} 🐛 💻	_Spenhouet 🐛 👀
_mtkumar123 💻	_{Davide Consalvo} 💻 💬 🎨	_{Bruno Santos} 🐛	_{cgkoutzigiannis} ⚠️	_{I Wayan Kurniawan} 📖	_{Sven Eliasson} 📖	_{gonzalobarbaran} 💻
_{Nuttapat Koonarangsri} 📖	_{Sokratis Vasiliou} 🌍	_semaeostomea 📖	_{Josué Millán Zamora} 💻	_me-suzy 🐛	_dmail00 🐛