Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/py-pdf/pdfly

CLI tool to extract (meta)data from PDF and manipulate PDF files
https://github.com/py-pdf/pdfly

application cli hacktoberfest pdf python terminal terminal-based

Last synced: 10 months ago
JSON representation

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

Awesome Lists containing this project

README 

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

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

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

[![Documentation Status](https://readthedocs.org/projects/pdfly/badge/?version=latest)](https://pdfly.readthedocs.io/en/latest/?badge=latest)



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

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

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

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



[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![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/)



# pdfly



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



## Installation



```bash

pip install -U pdfly

```



As `pdfly` is an application, you might want to install it with [`pipx`](https://pypi.org/project/pipx/).



## Usage



```console

$ pdfly --help



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



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



╭─ Options ────────────────────────────────────────────────────────────────────────────╮

│ --version                                                                            │

│ --help                    Show this message and exit.                                │

╰──────────────────────────────────────────────────────────────────────────────────────╯

╭─ Commands ───────────────────────────────────────────────────────────────────────────╮

│ 2-up                      Create a booklet-style PDF from a single input.            │

│ cat                       Concatenate pages from PDF files into a single PDF file.   │

│ compress                  Compress a PDF.                                            │

| uncompress                Uncompresses a PDF.                                        │

| extract-annotated-pages   Extract only the annotated pages from a PDF.               |

│ extract-images            Extract images from PDF without resampling or altering.    │

│ 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.                               │

│ 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`:



```console

$ pdfly 2-up --help



 Usage: pdfly 2-up [OPTIONS] PDF OUT



 Create a booklet-style PDF from a single input.

 Pairs of two pages will be put on one page (left and right)



 usage: python 2-up.py input_file output_file



╭─ Arguments ──────────────────────────────────────────────────────────────────────────╮

│ *    pdf      PATH  [default: None] [required]                                       │

│ *    out      PATH  [default: None] [required]                                       │

╰──────────────────────────────────────────────────────────────────────────────────────╯

╭─ Options ────────────────────────────────────────────────────────────────────────────╮

│ --help          Show this message and exit.                                          │

╰──────────────────────────────────────────────────────────────────────────────────────╯

```



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

    

  



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!



The list might not be complete. You can find more contributors via the git

history and [GitHubs 'Contributors' feature](https://github.com/py-pdf/pdfly/graphs/contributors).