Public | Automated Build

Last pushed: 4 days ago
Short Description
Path File IO Handler
Full Description

##############
pfioh - v1.5.5

##############

.. image:: https://badge.fury.io/py/pman.svg
:target: https://badge.fury.io/py/pman

.. image:: https://travis-ci.org/FNNDSC/pman.svg?branch=master
:target: https://travis-ci.org/FNNDSC/pman

.. image:: https://img.shields.io/badge/python-3.5%2B-blue.svg
:target: https://badge.fury.io/py/pman

.. contents:: Table of Contents


Overview


This repository provides pfioh -- a server process (think of it as anonymous ftp that natively understands recursive paths) that allows for file/path push/copy.

  • pfioh: a file IO manager;

pfioh

pfioh is a service that pushes/pulls files and directories between different locations.


Installation


Installation is relatively straightforward, and we recommend using either python virtual environments or docker.

Python Virtual Environment

On Ubuntu, install the Python virtual environment creator

.. code-block:: bash

sudo apt install virtualenv

Then, create a directory for your virtual environments e.g.:

.. code-block:: bash

mkdir ~/python-envs

You might want to add to your .bashrc file these two lines:

.. code-block:: bash

export WORKON_HOME=~/python-envs
source /usr/local/bin/virtualenvwrapper.sh

Then you can source your .bashrc and create a new Python3 virtual environment:

.. code-block:: bash

source .bashrc
mkvirtualenv --python=python3 python_env

To activate or "enter" the virtual env:

.. code-block:: bash

workon python_env

To deactivate virtual env:

.. code-block:: bash

deactivate

Using the fnndsc/ubuntu-python3 dock

We provide a slim docker image with python3 based off Ubuntu. If you want to play inside this dock and install pman manually, do

.. code-block:: bash

docker pull fnndsc/ubuntu-python3

This docker has an entry point python3. To enter the dock at a different entry and install your own stuff:

.. code-block:: bash

docker run -ti --entrypoint /bin/bash fnndsc/ubuntu-python3

Now, install pfioh and friends using pip

.. code-block:: bash

apt update && \
apt install -y libssl-dev libcurl4-openssl-dev librtmp-dev && \
pip install pfioh

If you do the above, remember to commit your changes to the docker image otherwise they'll be lost when you remove the dock instance!

.. code-block:: bash

docker commit <container-ID> local/pfioh

where <container-ID> is the ID of the above container.

Using the fnndsc/pfioh dock

The easiest option however, is to just use the fnndsc/pfioh dock.

.. code-block:: bash

docker pull fnndsc/pfioh

and then run

.. code-block:: bash

docker run --name pfioh -v /home:/Users --rm  fnndsc/pfioh --forever --httpResponse --storeBase=/tmp --createDirsAsNeeded

Usage


pfioh usage

For pfioh detailed information, see the pfioh wiki page <https://github.com/FNNDSC/pfioh/wiki/pfioh-overview>_.

Docker Pull Command
Owner
fnndsc
Source Repository