README.rst

Timestamp maker plugin

Table of Contents

• Abstract
• Description
• Usage
  • Optional arguments
  • Getting inline help
  • Run
• Development
  • Building
  • Local Test Run
• Examples

Abstract

Create timestamps for the ChRIS project(s).

Description

timestampmaker is a ChRIS ds-type plugin application that adds the date and time to image(s) and video(s) based on their creation time. This plugin can handle multiple files of differing types instead of a single file at a time.

Usage

Imaging softwares can make use of pl-timestampmaker to add or print the date and time on the image(s) and video(s) using the data that was saved along with the image(s) and video(s) when it was captured or created.

docker run --rm fnndsc/pl-timestampmaker timestampmaker
    [-h|--help]
    [--json] [--man] [--meta]
    [--savejson <DIR>]
    [-v|--verbosity <level>]
    [--version]
    <inputDir> <outputDir>

Optional arguments

[-h] [--help]
If specified, show help message and exit.

[--json]
If specified, show json representation of app and exit.

[--man]
If specified, print (this) man page and exit.

[--meta]
If specified, print plugin meta data and exit.

[--savejson <DIR>]
If specified, save json representation file to DIR and exit.

[-v <level>] [--verbosity <level>]
Verbosity level for app. Not used currently.

[--version]
If specified, print version number and exit.

Getting inline help

docker run --rm fnndsc/pl-timestampmaker timestampmaker --man

Run

You need to specify input and output directories using the -v flag to docker run.

docker run --rm -u $(id -u)                             \
    -v $(pwd)/in:/incoming -v $(pwd)/out:/outgoing      \
    fnndsc/pl-timestampmaker timestampmaker             \
    /incoming /outgoing

Development

Instructions for developers.

Building

Build the Docker container:

docker build -t local/pl-timestampmaker .

Local Test Run

Run unit tests:

docker run --rm local/pl-timestampmaker nosetests

Examples

The example code reads the files from /incoming folder, timestamps them and saves them in the /outgoing folder.

docker run --rm -it                                         \
    -v $(pwd)/in:/incoming -v $(pwd)/out:/outgoing          \
    -privileged local/pl_timestampmaker timestampmaker      \
    /incoming /outgoing