Skip to content
py-pdfPublic

About

CLI tool to extract (meta)data from PDF and manipulate PDF files

Topics

Resources

Stars

579 stars

Watchers

7 watching

Forks

Repository files navigation

Pypi latest version Python Support License: BSD 3 Clause Documentation Status

build status GitHub last commit issues closed PRs closed

linters: ruff, mypy Pull Requests Welcome first-timers-only Friendly

pdfly

pdfly (say: PDF-li) is a pure-python cli application for manipulating PDF files.

pdfly logo

Installation

pip install -U pdfly

As pdfly is an application, you might want to install it with pipx or uv tool: uvx pdfly --help

Usage

$ pdfly --help

 Usage: pdfly [OPTIONS] COMMAND [ARGS]...

 pdfly is a pure-python cli application for manipulating PDF files.

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --version        <bool>                                                                          │
│ --help           <bool>  Show this message and exit.                                             │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ 2-up                     Put each pair of pages side by side on one page.                        │
│ booklet                  Reorder and two-up PDF pages for booklet printing.                      │
│ cat                      Concatenate pages from PDF files into a single PDF file.                │
│ check-sign               Verifies the signature of a signed PDF.                                 │
│ compress                 Compress a PDF.                                                         │
│ extract-annotated-pages  Extract only the annotated pages from a PDF.                            │
│ extract-images           Extract images from PDF without resampling or altering.                 │
│ extract-links            Extract all links from a PDF document.                                  │
│ extract-text             Extract text from a PDF file.                                           │
│ meta                     Show metadata of a PDF file                                             │
│ pagemeta                 Give details about a single page.                                       │
│ rm                       Remove pages from PDF files.                                            │
│ rotate                   Rotate specified pages by the specified amount                          │
│ sign                     Creates a signed PDF from an existing PDF file.                         │
│ decrypt                  Remove password protection from an encrypted PDF file.                  │
│ uncompress               Uncompress the page content streams of a PDF.                           │
│ update-offsets           Updates offsets and lengths in a simple PDF file.                       │
│ x2pdf                    Convert one or more files to PDF. Each file is a page.                  │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯

You can see the help of every subcommand by typing --help:

$ pdfly 2-up --help

 Usage: pdfly 2-up [OPTIONS] {pdf} {out}

 Put each pair of pages side by side on one page.

 Pages 1 and 2 become the left and right half of the first output page,
 pages 3 and 4 the left and right half of the second one, and so on.
 If the number of pages is odd, the right half of the last output page
 stays blank. The page order is not changed; use `pdfly booklet` to
 reorder the pages for booklet printing.

 Example:
     pdfly 2-up input.pdf output.pdf

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    pdf      <file>  [required]                                             │
│ *    out      <path>  [required]                                             │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help        <bool>  Show this message and exit.                            │
╰──────────────────────────────────────────────────────────────────────────────╯

Note: pdfly has nothing to do with pdfly.net or gopdfly.com

Contributors ✨

pdfly is a free software project without any company affiliation. We cannot pay contributors, but we do value their contributions 🤗

Martin Thoma
Martin Thoma

💻 📖 🤔 🚇 🚧 📆 ✅
Lucas Cimon
Lucas Cimon

🐛 💻 📖 🚧
Rob Adams
Rob Adams

💻
Harsh
Harsh

💻
Sascha Rogmann
Sascha Rogmann

💻
Enrique Botía
Enrique Botía

💻
kommade
kommade

💻
Zingzy
Zingzy

💻
Subhajit Sahu
Subhajit Sahu

💻
Kian-Meng Ang
Kian-Meng Ang

🤔
Hal Wine
Hal Wine

🐛 💻
philippesamuel
philippesamuel

📖
marcobrb
marcobrb

📖
moormaster
moormaster

📖 💻
Geoff Beier
Geoff Beier

💻
Yuriy Chernyshov
Yuriy Chernyshov

🤔 💻
lkintact
lkintact

🐛

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

The list might not be complete. You can find more contributors via the git history and GitHubs 'Contributors' feature.

About

CLI tool to extract (meta)data from PDF and manipulate PDF files

Topics

Resources

Stars

579 stars

Watchers

7 watching

Forks

Releases

Packages

Used by

Contributors

Languages