Tutorial

The module can be run directly from the command line. For example for a slideshow of all the photos in the c:\temp directory would be:

python -m photoshow c:/temp

There are further configurable options, for these you can specifiy a parameter json file, see blow for parameter details.

python -m photoshow c:/temp/parameters.json

Or imported from another module. Call the present function to run the slides.

import photoshow
photoshow.present('c:/temp', caption='detail', delay_time=5)

The parameters file can still be used if enbedding in another module.

import photoshow
photoshow.present('c:/temp/parameters.json')

The path parameter normally contains either the photos path or the path for the parameters file. To override the path in the parameters file, pass the overriding path using the override_path parameter.

import photoshow
photoshow.present('c:/temp/parameters.json', override_path='c:/myphotos')

Controls

During the slideshow, use the spacebar or mouse button to move on to skip on to the next image, and press escape or mouse double-click to end the show.

Parameters

Further configuarble parameters, incude whether captions are required and what font should they be in, the time each photo is displayed for, whether the photos should be randomised or played in order, should the slideshow repeat when it reaches the end, plus some others.

path: String, the path to the photo library or the parameter file. This is the only mandatory parameter.
caption: String or boolean, whether a caption should be added to the slide and if so which, options are: directory, detail, filename. The detail option will try and use Exif data from the DateTimeOriginal and ImageDescription elements, falling back to the folder name if data is not found. Use False for no caption.
delay_time: Int, the time each photo is displayed for. Default 15
delay_unit: String, either M minutes or S seconds. Default S
font_path: String, the true type font file, including path. The recommended font is Kalam-Bold.ttf, which can be downloaded from Google Fonts,
max_photos: Int, the photo limit for the slideshow, enter 0 for unlimited.
override_path: String, use only when the photo path should override the path in the parameters file.
random: Boolean, true if photos should be randomised, false will play the slides in order. Default true.
repeat: Boolean, true starts over when all photos have been displayed, false will end the slideshow after one run through. Default true.
ignore: List, of directories and/or files that should not be shown in the slideshow. Only include the path from the photo_path location.

The parameters should be kept in a json file, such as:

{
    "captions": "detail",
    "delay_time": 2,
    "delay_unit": "S",
    "font_path": "C:/Temp/Kalam-Bold.ttf",
    "max_photos": 0,
    "path": "C:/Temp",
    "random": true,
    "repeat": true,
    "ignore": [
        "C:/Temp/ignoreme",
        "C:/Temp/ignoreonephoto/whatever.jpg"
    ]
}

Although these can be overridden by passing them to the present function.