fpdf2 (original) (raw)

fpdf2 logo

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(text="hello world") pdf.output("hello_world.pdf")

Go try it now online in a Jupyter notebook: or

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

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/py-pdf/fpdf2.git@master

Features

Python 3.8+ 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
Tables and also 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 batches
Images & links alternative descriptions, for accessibility
Table of contents & document outline
Document encryption & document signing
Annotations, including text highlights, and file attachments
Presentation mode with control over page display duration & transitions
Optional basic Markdown-like styling: **bold**, __italics__
Can render mathematical equations & charts
Usage examples with Django, Flask, FastAPI, streamlit, AWS lambdas... : Usage in web APIs
more than 1300 unit tests running under Linux & Windows, with qpdf-based PDF diffing, timing & memory usage checks, and a high code coverage

Our 350+ 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! ⭐

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 - Ελληνικά - עברית - 简体中文 - বাংলা - ភាសាខ្មែរ - 日本語 - Dutch - Polski - Türkçe - Indonesian- Slovenščina
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!

Development

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🐛 💻	Gerardo Allende💻 🔬
Nicholas Jin🐛	Yusuke💻	Tillrzhtgrfho🐛	Dario Ackermann🐛	Tzvi Greenfeld📖 🌍	devdev29📖 💻	Johan Bonneau📖
Jesús Alberto Muñoz Mesa⚠️ 📖 🌍	Jaydeep Das💬	Sean💻	Anderson Herzogenrath da Costa💬 💻 🔬 🐛 📖 🤔 🚧	Yi Wei Lan⚠️	CpDong💻 🐛 🌍	CY-Qiu🐛
Markovvn1💻	Elad Rapaport💻	SfinxV🐛	bramantoleksono🐛	TheNerdy907🐛	Elie Roux🐛 🤔 💻 💬	msalem📖
Manuel Ruiz🐛	Noel🐛	Avik Sarkar🌍 📖 💬	aeris07🐛	KamarulAdha📖	Valerus5685🐛	Sebastian Tia💻
Eugene Selifonov🐛	Kuth🌍	Ruben de Bruin🐛 💻 📖	stenci🐛	alcnaka🌍	Tolker-KU💻	lfavole💻
Nicolai Wolfrom🐛	Sandra🤔 💻	navitho🐛	Sai Harsha Kottapalli💻	Rakesh N J📖	rodos🐛	Ted Brookings💻
Andy Friedman💻	Matt📖	matipos2📖	lry12138🌍	Martijn Jasperse🐛 💻	demiurgepy🐛	Marek Tovlin💻
Polderrider🌍	Elena ``of Valhalla''⚠️	Niall O'Callaghan🐛	jsid72🐛	Alan Collins💻	hyperstown🖋	Clock-Speed💻
Darek🌍	Carl Higgs💻	awmc000💻	Scott Smitelli🐛	lcgeneralprojects🐛 💻	Christopher Lane📖 ⚠️	David💻
Sezer Bozkır🌍	Odhy Pradhana🌍	Li 🐛	Matthias Schoettle📖 🐛	Steve Simmons🐛	João Henrique📖	Bernhard Miklautz📖
Bryn Jeffries🐛	Benoit Charbonneau🤔	Philip Jones🐛	opposss💻	Dat Le🐛 💻	Kaustubh 💻	Derek Robinson🐛
Kevin Castro🐛	jasonfevangsafe📖 🐛 💻	visheshdvivedi💻	petri-lipponen-movesense💻	Soomin Choi💻	Black-Hole🌍	lka💻 📖 🤔 ✅
andreaswimmer🐛	Mercuron💻