Skip to main content

基于 pikepdf 封装的命令行工具,处理 PDF 文件用

Project description

PDFWork

基于 pikepdf 封装的一个便于使用的 pdf 处理命令行工具。 提供以下功能:

  • 书签(也叫目录)
    • 导入、导入、抹除PDF文件中的书签
  • 合并 PDF
  • 分割 PDF

安装方法

可以通过 pip 或 pipx 安装:

# pip
pip install pdfwork
# pipx
pipx install pdfwork

使用

合并 PDF 文件

假设你有一堆 PDF 文件,那么你可以使用 pdfwork merge 子命令来将它们合并。使用 -o 选项指定合并后的文件保存路径。

要输入需要合并的文件,有三种方法:

  1. 直接在命令行中输入: -i alpha.pdf beta.pdf gamma.pdf
  2. 在以 @ 开头的文本文件(例如 @pdf.list.txt)中以 每行一个 的形式编写 PDF 片段的路径,然后用 -i @pdf.list.txt 的形式指定列表文件。程序会在指定文件中读取 PDF 片段的路径。
$ pdfwork merge -o merged.pdf a.pdf b.pdf c.pdf

$ pdfwork merge -o merged.pdf @abc.list.txt

@abc.list.txt 的内容如下:

a.pdf
b.pdf
c.pdf

拆分 PDF 文件

pdfwork 可以将一个完整的 PDF 文件按页拆分成单页 PDF。使用 -i origin.pdf 输入源文件路径。然后通过 -o prefix.{:03d}.pdf 设置输出文件名模板。

可以在模板中使用 Python format 风格的占位符(详见 https://docs.python.org/zh-cn/3/library/string.html\#formatspec),例如 {:d}{:04d} 之类,像十六进制的 {:x}、八进制的 {:o} 和二进制的 {:b} 也是可以使用的。

-o 参数未指定时,程序会使用类似于 {:0d}.pdf 这样的模板,但自动推导宽度,以确保生成 001.pdf ~ 999.pdf 样式的文件。

$ pdfwork split origin.pdf -o "origin.{:04d}.pdf"

导入导出 PDF 文件的书签

pdfwork 提供一种字面形式的书签描述语言,可以描述书签的标题、页码和嵌套关系。导入时,将描述语言转换成 PDF 的书签结构写入 PDF;导出时,从 PDF 中读取书签结构,编码成描述语言。

描述语言以一行作为一条书签,通过 @ 将一行分为 标题和页码两个部分:

标题 @ 页码

并且用缩进来表示嵌套层级:

根书签 @ 页码
    子书签 1 @ 页码
    子书签 2

这里可以观察到, "子书签 2" 没有输入页码。这是因为如果相邻的书签具有相同的页码,那么除了第一条之外的书签页码都可以省略不写,由程序自动推导。

$ pdfwork outline import origin.pdf -i bookmarks.txt -o origin.bookmarked.pdf --offset 20

$ pdfwork outline export origin.pdf -o bookmarks.exported.txt

在导入时,通常需要输入一个参数 --offset,这个参数表示正文页码和物理页码的偏差。例如,大多数书籍都有封面、扉页、前言、目录等结构,这些结构并没有算在目录的页码里。因此,当从书籍的目录中将页码转抄过来,就会存在一个值为 offset 的偏差。假设正文第 1 页在 PDF 中的实际页码是 21,那么 offset = 21

  • 1 = 20。如果所操作的书籍没有此类问题,那么可以省略此参数,令程序使用默认值 offset = 0 。另外,程序会自动生成序号。

在导出时,各目录的页码已经计算成了物理页码,偏差归零。

docs/example.bookmark.txt 有一份示例的描述语言文本。

抹除书签

保存去除了书签信息的 PDF 版本。

$ pdfwork outline erase origin.pdf -o erased.pdf

优化 PDF 文档

可以优化 PDF 文档:

  1. 以线性化模式保存 PDF,以便网络加载
  2. 去除 PDF 中的重复图像对象,另所有图像引用指向唯一对象
  3. 去除 PDF 中未引用的资源

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pdfwork-0.4.0.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

pdfwork-0.4.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file pdfwork-0.4.0.tar.gz.

File metadata

  • Download URL: pdfwork-0.4.0.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.4 Windows/10

File hashes

Hashes for pdfwork-0.4.0.tar.gz
Algorithm Hash digest
SHA256 eeff3329adc29b38f16deedefb6b453e207c9d01697df17523668cd6c9e7833e
MD5 432f797eda15afea5445f0364fc72e97
BLAKE2b-256 4bef2246576c225085fcb7a0d6f02e9904aaf51fbf3ba920837252c695d7ffd6

See more details on using hashes here.

File details

Details for the file pdfwork-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: pdfwork-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.4 Windows/10

File hashes

Hashes for pdfwork-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e095203d96684c59dde40290f1ac1957102c42210d00ddd84b12f864fc92f63
MD5 795216f743582e75a88d148048499ecb
BLAKE2b-256 b411d439068bb1f1583ca117245965a81bb3123d388617a496ba1a36628f5214

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page