pfmisc 1.0.0

Misc utilities for FNNDSC python repos

Table of Contents

• Overview

  • pfmisc

• Usage

• Installation

  • Python Virtual Environment

  • Using the fnndsc/ubuntu-python3 dock

Overview

This repository provides pfmisc – miscellaneous services for the pf family.

pfmisc

Most simply, pfmisc provides debug and color modules.

Usage

Simply do a

import pfmisc

class MyClass():

    def __init__(self, *args, **kwargs):
        self.debug  = pfmisc.debug()

        self.debug.qprint('hello there!')

which will result in some decent debugging in stdout.

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

sudo apt install virtualenv

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

mkdir ~/python-envs

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

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

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

source .bashrc
mkvirtualenv --python=python3 python_env

To activate or “enter” the virtual env:

workon python_env

To deactivate virtual env:

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

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:

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

Now,

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

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!

 docker commit <container-ID> local/ubuntu-python3-pfdcm

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