https://py-pdf.github.io/fpdf2/

Simple PDF generation for Python
https://py-pdf.github.io/fpdf2/

barcode hacktoberfest library markdown pdf pdf-generation pdf-library python python3 svg

Last synced: about 1 month ago
JSON representation

Simple PDF generation for Python

• Host: GitHub
• URL: https://py-pdf.github.io/fpdf2/
• Owner: py-pdf
• License: lgpl-3.0
• Fork: true (reingart/pyfpdf)
• Created: 2017-03-15T15:31:54.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-29T03:54:48.000Z (4 months ago)
• Last Synced: 2024-05-29T05:49:38.693Z (4 months ago)
• Topics: barcode, hacktoberfest, library, markdown, pdf, pdf-generation, pdf-library, python, python3, svg
• Language: Python
• Homepage: https://py-pdf.github.io/fpdf2/
• Size: 301 MB
• Stars: 966
• Watchers: 22
• Forks: 227
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-python - py-pdf.github.io/fpdf2

README

        
[![Pypi latest version](https://img.shields.io/pypi/v/fpdf2.svg)](https://pypi.org/pypi/fpdf2#history)

[![Python Support](https://img.shields.io/pypi/pyversions/fpdf2.svg)](https://pypi.org/project/fpdf2/)

[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)

[![build status](https://github.com/py-pdf/fpdf2/workflows/build/badge.svg)](https://github.com/py-pdf/fpdf2/actions?query=branch%3Amaster)

[![codecov](https://codecov.io/gh/py-pdf/fpdf2/branch/master/graph/badge.svg)](https://codecov.io/gh/py-pdf/fpdf2)

![security: bandit, pylint, semgrep](https://img.shields.io/badge/linters-bandit,pylint,semgrep-yellow.svg)

[![Dependents](https://img.shields.io/librariesio/dependents/pypi/fpdf2)](https://libraries.io/pypi/fpdf2/dependents)

[![Downloads per month](https://pepy.tech/badge/fpdf2/month)](https://pepy.tech/project/fpdf2)

[![Contributors](https://img.shields.io/github/contributors/py-pdf/fpdf2)](https://github.com/py-pdf/fpdf2/graphs/contributors)

[![GitHub last commit](https://img.shields.io/github/last-commit/py-pdf/fpdf2)](https://github.com/py-pdf/fpdf2/commits/master)

[![issues closed](https://img.shields.io/github/issues-closed/py-pdf/fpdf2)](https://github.com/py-pdf/fpdf2/issues)

[![PRs closed](https://img.shields.io/github/issues-pr-closed/py-pdf/fpdf2)](https://github.com/py-pdf/fpdf2/pulls)

[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

[![first-timers-only Friendly](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](http://www.firsttimersonly.com/)

→ come look at our [good first issues](https://github.com/py-pdf/fpdf2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

# fpdf2

![fpdf2 logo](https://py-pdf.github.io/fpdf2/fpdf2-logo.png)

`fpdf2` is a PDF creation library for Python:

```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: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/py-pdf/fpdf2/blob/master/tutorial/notebook.ipynb) or [![Open In nbviewer](https://img.shields.io/badge/Open_In-nbviewer-blue?logo=jupyter)](https://nbviewer.org/github/py-pdf/fpdf2/blob/master/tutorial/notebook.ipynb)

Compared with other PDF libraries, `fpdf2` is **fast, versatile, easy to learn and to extend** ([example](https://github.com/digidigital/Extensions-and-Scripts-for-pyFPDF-fpdf2)).

It is also entirely written in Python and has very few dependencies:

[Pillow](https://pillow.readthedocs.io/en/stable/), [defusedxml](https://pypi.org/project/defusedxml/), & [fontTools](https://fonttools.readthedocs.io/en/latest/index.html). It is a fork and the successor of `PyFPDF` (_cf._ [history](https://py-pdf.github.io/fpdf2/History.html)).

**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](https://github.com/py-pdf/fpdf2/discussions)!

## Installation Instructions

```bash

pip install fpdf2

```

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

```bash

pip install git+https://github.com/py-pdf/fpdf2.git@master

```

## Features

 * Python 3.7+ support

 * [Unicode](https://py-pdf.github.io/fpdf2/Unicode.html) (UTF-8) TrueType font subset embedding

 * Internal / external [links](https://py-pdf.github.io/fpdf2/Links.html)

 * Embedding images, including transparency and alpha channel

 * Arbitrary path drawing and basic [SVG](https://py-pdf.github.io/fpdf2/SVG.html) import

 * Embedding [barcodes](https://py-pdf.github.io/fpdf2/Barcodes.html), [charts & graphs](https://py-pdf.github.io/fpdf2/Maths.html), [emojis, symbols & dingbats](https://py-pdf.github.io/fpdf2/EmojisSymbolsDingbats.html)

 * [Tables](https://py-pdf.github.io/fpdf2/Tables.html) and also [cell / multi-cell / plaintext writing](https://py-pdf.github.io/fpdf2/Text.html), with [automatic page breaks](https://py-pdf.github.io/fpdf2/PageBreaks.html), line break and text justification

 * Choice of measurement unit, page format & margins. Optional page header and footer

 * Basic [conversion from HTML to PDF](https://py-pdf.github.io/fpdf2/HTML.html)

 * A [templating system](https://py-pdf.github.io/fpdf2/Templates.html) to render PDFs in batches

 * Images & links alternative descriptions, for accessibility

 * Table of contents & [document outline](https://py-pdf.github.io/fpdf2/DocumentOutlineAndTableOfContents.html)

 * [Document encryption](https://py-pdf.github.io/fpdf2/Encryption.html) & [document signing](https://py-pdf.github.io/fpdf2/Signing.html)

 * [Annotations](https://py-pdf.github.io/fpdf2/Annotations.html), including text highlights, and [file attachments](https://py-pdf.github.io/fpdf2/FileAttachments.html)

 * [Presentation mode](https://py-pdf.github.io/fpdf2/Presentations.html) with control over page display duration & transitions

 * Optional basic Markdown-like styling: `**bold**, __italics__`

 * Can render [mathematical equations & charts](https://py-pdf.github.io/fpdf2/Maths.html)

 * Usage examples with [Django](https://www.djangoproject.com/), [Flask](https://flask.palletsprojects.com), [FastAPI](https://fastapi.tiangolo.com/), [streamlit](https://streamlit.io/), AWS lambdas... : [Usage in web APIs](https://py-pdf.github.io/fpdf2/UsageInWebAPI.html)

 * 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:

[![QPDF logo](https://py-pdf.github.io/fpdf2/qpdf-logo.svg)](https://github.com/qpdf/qpdf)

[![PDF Checker logo](https://py-pdf.github.io/fpdf2/pdfchecker-logo.png)](https://www.datalogics.com/products/pdf-tools/pdf-checker/)

[![VeraPDF logo](https://py-pdf.github.io/fpdf2/vera-logo.jpg)](https://verapdf.org)

## 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 😊

[![GitHub Repo stars](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit)](https://reddit.com/submit?url=https://github.com/py-pdf/fpdf2&title=fpdf2)

[![GitHub Repo stars](https://img.shields.io/badge/share%20on-hacker%20news-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/py-pdf/fpdf2)

[![GitHub Repo stars](https://img.shields.io/badge/share%20on-twitter-03A9F4?logo=twitter)](https://twitter.com/share?url=https://github.com/py-pdf/fpdf2&t=fpdf2)

[![GitHub Repo stars](https://img.shields.io/badge/share%20on-facebook-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/py-pdf/fpdf2)

[![GitHub Repo stars](https://img.shields.io/badge/share%20on-linkedin-3949AB?logo=linkedin)](https://www.linkedin.com/shareArticle?url=https://github.com/py-pdf/fpdf2&title=fpdf2)

## Documentation

- [Documentation Home](https://py-pdf.github.io/fpdf2/)

- Tutorial in several languages: [English](https://py-pdf.github.io/fpdf2/Tutorial.html) - [Deutsch](https://py-pdf.github.io/fpdf2/Tutorial-de.html) - [español](https://py-pdf.github.io/fpdf2/Tutorial-es.html) - [हिंदी](https://py-pdf.github.io/fpdf2/Tutorial-hi.html) - [português](https://py-pdf.github.io/fpdf2/Tutorial-pt.html) - [Русский](https://py-pdf.github.io/fpdf2/Tutorial-ru.html) - [Italian](https://py-pdf.github.io/fpdf2/Tutorial-it.html) - [français](https://py-pdf.github.io/fpdf2/Tutorial-fr.html) - [Ελληνικά](https://py-pdf.github.io/fpdf2/Tutorial-gr.html) - [עברית](https://py-pdf.github.io/fpdf2/Tutorial-he.html) - [简体中文](https://py-pdf.github.io/fpdf2/Tutorial-zh.html) - [বাংলা](https://py-pdf.github.io/fpdf2/Tutorial-bn.html) - [ភាសាខ្មែរ](https://py-pdf.github.io/fpdf2/Tutorial-km.html) - [日本語](https://py-pdf.github.io/fpdf2/Tutorial-ja.html) - [Dutch](https://py-pdf.github.io/fpdf2/Tutorial-nl.html) - [Polski](https://py-pdf.github.io/fpdf2/Tutorial-pl.html) - [Türkçe](https://py-pdf.github.io/fpdf2/Tutorial-tr.html)

- Release notes: [CHANGELOG.md](https://github.com/py-pdf/fpdf2/blob/master/CHANGELOG.md) 

- A series of blog posts: [fpdf2 tag @ ludochaordic](https://chezsoi.org/lucas/blog/tag/fpdf2.html)

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

## Development

Please check the [dedicated documentation page](https://py-pdf.github.io/fpdf2/Development.html).

## 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
🌍

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification

([emoji key](https://allcontributors.org/docs/en/emoji-key)).

Contributions of any kind welcome!

[![Contributors map](https://py-pdf.github.io/fpdf2/contributors-map-small.png)](https://py-pdf.github.io/fpdf2/contributors.html)

_(screenshot from January 2023, click on the map above to access an up-to-date online version)_

## Community, related tools, alternative libraries

More about those in [the documentation](https://py-pdf.github.io/fpdf2/#community).