Usage

Examples

imagecatalog -i images/*.png -o example.pdf --title 'Image Catalog'

imagecatalog   \
 -i images/*.png \
 -o example_landscape.pdf \
 --rows 2   \
 --cols 4   \
 --orientation landscape \
 --title 'Catalog with Landscape Layout' \

File paths and metadata can also be supplied from a csv file with headers “image”, “label”, “note”

$ head -n5 sample.csv
image,label,note
images/image_00.png,Image 0,image 0 note
images/image_01.png,Image 1,image 1 note
images/image_02.png,Image 2,image 2 note
images/image_03.png,Image 3,image 3 note

imagecatalog --csv sample.csv --title 'Catalog from CSV' -o example_csv.pdf

Other features: apply image filters

imagecatalog -i images/*.png -o catalog.pdf \
   --invert    \
   --grayscale \
   --autocontrast

Integrate with shell utilities

find . -ctime 1d | xargs imagecatalog -o catalog.pdf -i

Use regular expressions to filter files

imagecatalog -i images/*.png -o catalog.pdf --regex '.*(1|2).*'

usage: imagecatalog [-h] [-i IMAGE [IMAGE ...]] -o PDF [-s CSV] [-e REGEX]
                    [-r ROWS] [-c COLS] [--orientation {landscape,portrait}]
                    [--author AUTHOR] [--title TITLE] [--keywords KEYWORDS]
                    [--autocontrast] [--grayscale] [--invert] [-v] [-q] [-f]

Named Arguments

-i, --input

image file(s)

-o, --output

pdf file

-s, --csv

create catalog from csv file with headers ‘images,labels,notes’

-e, --regex

filter file list by regex pattern

pdf options

-r, --rows

number of table rows per page, defaults to 4

-c, --cols

number of table columns per page, defaults to 3

--orientation

Possible choices: landscape, portrait

landscape or portrait orientation, defaults to portrait

--author

document author

--title

document title

--keywords

document keywords

image options

--autocontrast

apply autocontrast to images

Default: False

--grayscale

convert color images to grayscale

Default: False

--invert

invert image colors

Default: False

other options

-v, --verbose

verbose output

Default: False

-q, --quiet

quite output

Default: False

-f, --force

force overwrite output

Default: False