pictureshow 0.6.4

Save pictures to PDF.

Save pictures to PDF from the command line or from your Python programs.

Requirements

• Python 3.6 or higher

• Pillow

• reportlab

Installation

pip install pictureshow

Usage

As a command line tool

usage: pictureshow [-h] [-p SIZE] [-L] [-m MARGIN] [-l LAYOUT] [-s] [-f]
                   [-q | -v] [-V]
                   PIC [PIC ...] PDF

positional arguments:
  PIC                   one or more input picture file paths
  PDF                   target PDF file path

optional arguments:
  -h, --help            show this help message and exit
  -p SIZE, --page-size SIZE
                        specify page size; default is A4
  -L, --landscape       force landscape orientation of page
  -m MARGIN, --margin MARGIN
                        set width of empty space around pictures; default is
                        72 (72 points = 1 inch)
  -l LAYOUT, --layout LAYOUT
                        specify grid layout of pictures on page, e.g. 2x3 or
                        2,3; default is 1x1
  -s, --stretch-small   scale small pictures up to fit drawing area
  -f, --force-overwrite
                        save target file even if filename exists
  -q, --quiet           suppress printing to stdout
  -v, --verbose         provide details on files skipped due to error
  -V, --version         show program's version number and exit

Example 1

Save a single picture to PDF.

$ pictureshow pics/mandelbrot.png mandelbrot.pdf
Saved 1 picture (1 page) to 'mandelbrot.pdf'

Example 2

Save pictures using a glob pattern [1], set page to landscape Letter-sized [2].

$ pictureshow pics/plots/gauss* gauss.pdf --landscape --page-size=LETTER
Saved 2 pictures (2 pages) to 'gauss.pdf'

Example 3

Save pictures using a URL pattern, set layout of 1x2 pictures per page.

$ pictureshow -l1x2 https://wiki.openttd.org/uploads/en/Manual/Town-{2x2,3x3}.png towns.pdf
Saved 2 pictures (1 page) to 'towns.pdf'

As a Python library

Using the PictureShow class:

from pictureshow import PictureShow

pic_show = PictureShow('pics/mandelbrot.png', 'pics/mandelbrot.jpg')
pic_show.save_pdf('pictures.pdf')

Using the pictures_to_pdf shortcut function:

from pictureshow import pictures_to_pdf

list_of_pictures = ['pics/mandelbrot.png', 'pics/mandelbrot.jpg']
pictures_to_pdf(*list_of_pictures, pdf_file='pictures.pdf')

Please note that unlike the command line interface, pdf_file must be specified as a keyword argument.

Another example, demonstrating all available keyword-only arguments:

from pathlib import Path

from pictureshow import pictures_to_pdf

list_of_pictures = sorted(Path.cwd().glob('pics/blender/*'))
pictures_to_pdf(
    *list_of_pictures,
    pdf_file='3d_pics.pdf',
    page_size='A5',
    landscape=True,
    margin=18,
    layout=(3, 3),
    stretch_small=True,
    force_overwrite=True
)

Footnotes

[1]

Please note that glob patterns are not expanded by the Windows command line shell.

[2]

Available page sizes are: A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, B0, B1, B2, B3, B4, B5, B6, B7, B8, B9, B10, C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, LETTER, LEGAL, ELEVENSEVENTEEN, JUNIOR_LEGAL, HALF_LETTER, GOV_LETTER, GOV_LEGAL, TABLOID, LEDGER