Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/py-pdf/pdfly
Owner: py-pdf
License: bsd-3-clause
Created: 2022-04-09T20:49:42.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-06-27T10:15:06.000Z (8 months ago)
Last Synced: 2024-07-07T09:08:12.618Z (8 months ago)
Topics: application, cli, hacktoberfest, pdf, python, terminal, terminal-based
Language: Python
Homepage:
Size: 1.6 MB
Stars: 75
Watchers: 6
Forks: 9
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI version](https://badge.fury.io/py/pdfly.svg)](https://pypi.org/project/pdfly/)
[![GitHub last commit](https://img.shields.io/github/last-commit/py-pdf/pdfly)](https://github.com/py-pdf/pdfly)
[![Python Support](https://img.shields.io/pypi/pyversions/pdfly.svg)](https://pypi.org/project/pdfly/)
[![Documentation Status](https://readthedocs.org/projects/pdfly/badge/?version=latest)](https://pdfly.readthedocs.io/en/latest/?badge=latest)
[![](https://img.shields.io/badge/-documentation-green)](https://pdfly.readthedocs.io/en/latest/)

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

```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}
💻 📖 🤔 🚇 🚧 📆 ✅

_{Lucas Cimon}
🐛 💻 📖 🚧

_{Rob Adams}
💻

_Harsh
💻

_{Sascha Rogmann}
💻

_{Enrique Botía}
💻

_kommade
💻

_Zingzy
💻

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