README.rst

pl-ipfs

Table of Contents

• Abstract
• Description
• Usage
  • Arguments
  • Run
• Development
• Examples

Abstract

A peer-to-peer hypermedia protocol designed to preserve and grow humanity's knowledge by making the web upgradeable, resilient, and more open.

Description

ipfs is a ChRIS ds-type application that takes in ... as ... files and produces ...

Usage

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

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 is:

docker run --rm fnndsc/pl-ipfs ipfs --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-ipfs ipfs                        \
    /incoming /outgoing

Development

Build the Docker container:

docker build -t local/pl-ipfs .

Run unit tests:

docker run --rm local/pl-ipfs nosetests

Examples

Put some examples here!