wrapper-bar 0.1.2

Progress Bar with command wrapping

Overview

Wrapper-Bar is a python module to help wrap commands with the progress bar. Wrapper-Bar helps in wrapping shell commands, or even python scripts with a progress bar and ETA.

Badges

Table of Contents

• Installation
• Usage
• Uninstall

Installation

To install wrapper-bar, use pip.

pip install wrapper-bar==0.1.2

Usage

• Import the Wrapper class.

  >>> from wrapper_bar.wrapper import Wrapper
  

• Initialize the Wrapper Class.

  >>> wrapControl = Wrapper(*params) # for parameters, check docstring.
  

• Docstring

  # to check docstring, in terminal/CMD, run:
  $ pydoc wrapper_bar.wrapper.Wrapper
  

• Methods

  • decoy

    >>> wrapControl.decoy(*params) # parameters are in the docstring.
    # decoy is for creating empty progressbar.
    

  • shellWrapper

    >>> wrapControl.shellWrapper(*params) # parameters are in the docstring.
    # shellWrapper can wrap list of shell commands across the progressbar.
    

  • pyWrapper

    >>> wrapControl.pyWrapper(*params) # parameters are in the docstring.
    # pyWrapper can wrap list of python scripts across the progressbar.
    

  • pyShellWrapper

    >>> wrapControl.pyShellWrapper(*params) # parametes are in the docstring.
    # pyShellWrapper can wrap inline python code across a progressbar.
    

Uninstall

To uninstall wrapper-bar, use pip.

pip uninstall wrapper-bar