PDF, Portable Document Format

Ghostscript

A classic, very useful but kind of ugly and bizarre to use. See Ghostscript for more info; I won’t document it here because I prefer easier tools. I keep ghostscript around because some other sofware I use depends upon it. 🏗️

QPDF

Less powerful, but simpler and less fragile than ghostscript.

• QPDF: A Content-Preserving PDF Transformation System
• qpdf/qpdf: Primary QPDF source code and documentation
• QPDF Manual

QPDF is a command-line program that does structural, content-preserving transformations on PDF files. It could have been called something like pdf-to-pdf. It also provides many useful capabilities to developers of PDF-producing software or for people who just want to look at the innards of a PDF file to learn more about how they work. … QPDF includes support for merging and splitting PDFs through the ability to copy objects from one PDF file into another and to manipulate the list of pages in a PDF file. Th…

QPDF is not a PDF content creation library, a PDF viewer, or a program capable of converting PDF into other formats. In particular, QPDF knows nothing about the semantics of PDF content streams. If you are looking for something that can do that, you should look elsewhere. However, once you have a valid PDF file, QPDF can be used to transform that file in ways perhaps your original PDF creation can’t handle. For example, programs generate simple PDF files but can’t password-protect them, web-optimize them, or perform other transformations of that type.

Searching

Shawn Graham suggests a pdftotext hack. First, install poppler using your choice of package manager. Now,

find /MLR -name '*.pdf' -exec sh \
  -c 'pdftotext "{}" - | grep --with-filename --label="{}" \
  --color "SEARCHTERM"' \;

Reduce bloat

PDFs have a lot of ways of storing data and many of them leave you keeping lots of crap there that you do not need for the current purpose, in the form of, presumably, inefficiently compressed images, excessively high resolution images, or miscellaneous other crap. Slimming them down to the essentials is in general complicated and context-dependent, and I do not know of a general solution. Here are some that work in some contexts.

Classic ghostscript method:

gs -sDEVICE=pdfwrite -dCompatibilityLevel=1.5 \
  -dPDFSETTINGS=/ebook \
  -dNOPAUSE -dQUIET -dBATCH \
  -sOutputFile=output.pdf input.pdf

Wrapped up into a nice little script, ShrinkPDF: (90 is the dpi here.)

./shrinkpdf.sh in.pdf out.pdf 90

There is also cpdf and the GUI version Densify.

Commercial online PDF tool smallpdf claims to shrink PDFs also. (USD12/month with free trial.)

A peer recommendation: PDF Resizer.

Wet ink signatures without printer

Many business demand “wet ink” signatures on signed PDFs, i.e. that we fill the digital form in, then print it, sign it and then scan it in again. This wastes time, money, paper and adds no discernable security to the truly shitty security mechanism that is signing things with ink. In the hypothetical case that it makes absolutely no legal difference, it could be automated.

I expect that the following methods might be much easier, cheaper, no less secure and for all purposes indistinguishable from printing and scanning a wet ink signature: We can automate fake-printing so that it at least saves time and money. Here are many scripts to simulate a round trip via the printer:

• Show HN: Make Your PDF Look Scanned
• Make a pdf look scanned using ImageMagick

I quite like

convert -density 100 input.pdf -rotate "$([ $((RANDOM % 2)) -eq 1 ] && echo -)0.$(($RANDOM % 4 + 5))" -attenuate 0.4 +noise Multiplicative -attenuate 0.03 +noise Multiplicative -sharpen 0x1.0 -colorspace Gray output.pdf

The scripts get much more elaborate than that though. Please do not use them to do anything illegal. Also, if you have a serious contractual obligation that hinges upon the “wet ink” quality of the signature rather than a more substantive mechanism for verifying your identity and consent (such as cryptographic signing, and witnesses) then perhaps you should reconsider the wisdom of the entire project.

PDF to text

OCRMyPDF makes a scanned PDF possibly-searchable and also optimizes the size, optionally aggressively. This will not downsample, but it will get better monochrome compression than normal.

Dangerzone is more extreme still; it deliberately rasterizes the PDF and deletes all metadata to make it anonymous and safe before OCRing it to get the text out:

Dangerzone works like this: You give it a document that you don’t know if you can trust (for example, an email attachment). Inside of a sandbox, dangerzone converts the document to a PDF (if it isn’t already one), and then converts the PDF into raw pixel data: a huge list of RGB color values for each page. Then, in a separate sandbox, dangerzone takes this pixel data and converts it back into a PDF.

Read the blog post for more information.

The PDF that results is less capable and has errors etc but also safe(r).

EPS to PDF

EPS to PDF conversion:

ps2pdf14 -dEPSCrop Logo.eps

PDF to SVG

pdf2svg generates editable vector diagrams from the PDF.

HTML to PDF

wkhtmltopdf

wkhtmltopdf and wkhtmltoimage are open source (LGPLv3) command line tools to render HTML into PDF and various image formats using the Qt WebKit rendering engine. These run entirely “headless” and do not require a display or display service.

Note also that Weasyprint, above, does this out of the box.

To CMYK

CMYK Color conversion of RGB PDF with GhostScript:

gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite \
  -sColorConversionStrategy=CMYK \
  -sColorConversionStrategyForImages=CMYK \
  -sDEVICE=pdfwrite \
  -dProcessColorModel=/DeviceCMYK \
  -dCompatibilityLevel=1.5 \
  -sOutputFile=result_cmyk.pdf \
  your_document.pdf

See also a PDF to TIFF example.

To Greyscale

gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite \
  -sColorConversionStrategy=Gray \
  -dProcessColorModel=/DeviceGray \
  -dCompatibilityLevel=1.5 \
  -sOutputFile=result_gray.pdf \
  your_document.pdf

Weasyprint

Weasyprint seems the cleanest. It converts HTML+CSS into PDF, and is written in pure python. It can be used from the command line or programatically.

It is based on various libraries but not on a full rendering engine like Blink, Gecko or WebKit. The CSS layout engine is written in Python, designed for pagination, and meant to be easy to hack on.

pip install weasyprint
weasyprint https://weasyprint.org/ weasyprint.pdf

SVGlib

svglib provides a pure python library that can convert SVG to PDF, and a command line utility for same, svg2pdf. Thus one can, e.g. add SVGs to PDFs in reportlab.

Reportlab

Apropos that, reportlab is the famed monstrous classic way of programatically generating PDFs from code. It includes a modicum of typesetting. It doesn’t edit PDFs so much, but it generates them pretty well. Its integration with other things is often weak — if you thought that inserting LaTeX equations would be simple, or HTML snippets etc. On the other hand it has fancy features such as its own chart generation library. On the third hand, there are better, more widely supported charting libraries that it doesn’t use. Litmus test: Use it if the following feels to you like a natural way to print two columns:

from reportlab.platypus import (
  BaseDocTemplate,
  Frame,
  Paragraph,
  PageBreak,
  PageTemplate )
from reportlab.lib.styles import getSampleStyleSheet
import random

words = (
  "lorem ipsum dolor sit amet consetetur "
  "sadipscing elitr sed diam nonumy eirmod "
  "tempor invidunt ut labore et").split()

styles=getSampleStyleSheet()
Elements=[]

doc = BaseDocTemplate(
  'basedoc.pdf',
  showBoundary=1)

#Two Columns

frame1 = Frame(
  doc.leftMargin,
  doc.bottomMargin,
  doc.width/2-6,
  doc.height,
  id='col1')
frame2 = Frame(
  doc.leftMargin+doc.width/2+6,
  doc.bottomMargin,
  doc.width/2-6,
  doc.height,
  id='col2')

Elements.append(
  Paragraph(
    " ".join([random.choice(words) for i in range(1000)]),
    styles['Normal']))
doc.addPageTemplates([
  PageTemplate(id='TwoCol',frames=[frame1,frame2]),
])

#start the construction of the pdf
doc.build(Elements)

pdfrw

pdfrw:

pdfrw is a Python library and utility that reads and writes PDF files:

• Operations include subsetting, merging, rotating, modifying metadata, etc. […]
• Can be used either standalone, or in conjunction with reportlab to reuse existing PDFs in new ones

Here is a gentle HOWTO. You can use it to put matplotlib plots in reportlab PDFs, getting the best of two bad worlds.

Scribus

scribus is a reasonable open-source desktop publishing tool. If your content is not amenable to automatic layout out it is a good choice, for e.g. posters. It includes a Python API, albeit a reputedly quirky one, which is AFAICT Python 2. For all that, it’s a simple and interactive way of generating PDFs programmatically, so might be worth it.