.. image:: https://badge.fury.io/py/app.svg :target: https://badge.fury.io/py/app
.. image:: https://travis-ci.org/FNNDSC/app.svg?branch=master :target: https://travis-ci.org/FNNDSC/app
.. image:: https://img.shields.io/badge/python-3.5%2B-blue.svg :target: https://badge.fury.io/py/pl-app
.. contents:: Table of Contents
An app to ...
.. code::
python app.py \
[-v <level>] [--verbosity <level>] \
[--version] \
[--man] \
[--meta] \
<inputDir>
<outputDir>
app.py is a ChRIS-based application that...
.. code::
[-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.
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
.. code:: bash
pip install app
and run with
.. code:: bash
app.py --man /tmp /tmp
to get inline help. The app should also understand being called with only two positional arguments
.. code:: bash
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
.. code:: bash
docker run --rm -v $(pwd)/out:/outgoing \
fnndsc/pl-app app.py \
Thus, getting inline help is:
.. code:: bash
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
Content type
Image
Digest
Size
171.4 MB
Last updated
almost 7 years ago
docker pull quinnyyy/pl-app