quinnyyy / pl-app

pl-app

Table of Contents

• Abstract
• Synopsis
• Description
• Agruments
• Run
  • Using PyPI
  • Using docker run
• Examples

Abstract

An app to ...

Synopsis

python app.py                                           \
    [-v <level>] [--verbosity <level>]                          \
    [--version]                                                 \
    [--man]                                                     \
    [--meta]                                                    \
    <inputDir>
    <outputDir>

Description

app.py is a ChRIS-based application that...

Agruments

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

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

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

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

Run

This plugin can be run in two modes: natively as a python package or as a containerized docker image.

Using PyPI

To run from PyPI, simply do a

pip install app

and run with

app.py --man /tmp /tmp

to get inline help. The app should also understand being called with only two positional arguments

app.py /some/input/directory /destination/directory

Using docker run

To run using docker, be sure to assign an "input" directory to /incoming and an output directory to /outgoing. Make sure that the $(pwd)/out directory is world writable!

Now, prefix all calls with

docker run --rm -v $(pwd)/out:/outgoing                             \
        fnndsc/pl-app app.py                        \

Thus, getting inline help is:

mkdir in out && chmod 777 out
docker run --rm -v $(pwd)/in:/incoming -v $(pwd)/out:/outgoing      \
        fnndsc/pl-app app.py                        \
        --man                                                       \
        /incoming /outgoing

Examples