pictureshow 0.3.3

Save pictures to PDF

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

As a command line tool

Usage:

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

positional arguments:
  PIC                   one or more input picture file paths
  PDF                   output 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 points (1 inch)
  -l LAYOUT, --layout LAYOUT
                        specify grid layout of pictures on page; default is
                        1x1
  -s, --stretch-small   scale small pictures up to fit drawing area
  -f, --force-overwrite
                        save output file even if filename exists
  -q, --quiet           suppress printing to stdout
  -v, --version         show program's version number and exit

Simple example — saving a single picture to PDF:

$ pictureshow picture.png pic.pdf
Saved 1 picture to '/.../pic.pdf'

Using a glob pattern, setting page to landscape Letter-sized:

$ pictureshow --page-size=LETTER -L *.jpg jpg_pics.pdf
Saved 4 pictures to '/.../jpg_pics.pdf'

Using multiple glob patterns, with half-inch margin and 1x3 pictures per page:

$ pictureshow --margin=36 --layout=1x3 *.png *.jpg *.gif all_pics.pdf
Saved 9 pictures to '/.../all_pics.pdf'

Combining glob pattern and additional filenames, overwriting existing output file, stretching small pictures to page, with zero margin:

$ pictureshow chart.gif *.jpg figure.png pics.pdf -fsm0
Saved 6 pictures to '/.../pics.pdf'

As a Python library

Using the PictureShow class:

from pictureshow import PictureShow

pic_show = PictureShow('pic1.png', 'pic2.jpg', 'pic3.gif')
pic_show.save_pdf('pictures.pdf')

Using the pictures_to_pdf shortcut function:

from pictureshow import pictures_to_pdf

pictures_to_pdf('pic1.png', 'pic2.jpg', 'pic3.gif', 'pictures.pdf')

The example above will work as long as the output file is passed as the last positional argument. It is however recommended to always use a keyword argument:

from pictureshow import pictures_to_pdf

list_of_pictures = ['pic1.png', 'pic2.jpg', 'pic3.gif']
pictures_to_pdf(*list_of_pictures, pdf_file='pictures.pdf')

Another example, demonstrating all available keyword parameters:

from pathlib import Path

from pictureshow import pictures_to_pdf

list_of_pictures = sorted(Path.cwd().glob('screenshots/*.png'))
pictures_to_pdf(
    *list_of_pictures,
    pdf_file='screenshots.pdf',
    page_size='A5',
    landscape=True,
    margin=36,
    layout=(2, 2),
    stretch_small=True,
    force_overwrite=True
)

The page_size and layout parameters can be specified either by a string or by a sequence of two numbers. For example, page_size='LETTER', layout='2x3' is equivalent to page_size=(72 * 8.5, 72 * 11), layout=(2, 3).