cmdprogress 1.2

Description:

cmdprogress 1.2

cmdprogress



Cross Platform Python Command Line Progress Bars
MacOS

Windows
Linux
Contents

Installation
ProgBar
MultiBar
Acknowledgements

Installation
Use pip via PyPi
pip install cmdprogress

Or use git
git clone git://github.com/luciancooper/cmdprogress.git cmdprogress
cd cmdprogress
python setup.py install

Usage
this project consists of two instantiatable classes: ProgBar and MultiBar
ProgBar
There are two ways to use a ProgBar
Either give it a length when you instantiate the object, and then directly loop through it
from cmdprogress.bar import ProgBar

bar = ProgBar(max=5)
for x in bar:
# x = (0 .. 5)
# do some work

Or do not provide it a length when you instantiate it, instead provide it an iterable to wrap
from cmdprogress.bar import ProgBar

bar = ProgBar()
for x in bar.iter(range(5)):
# x = (0 .. 5)
# do some work

MultiBar
There are 3 ways to use a MultiBar.
from cmdprogress.multi import MultiBar

bar = MultiBar(lvl=2)
for i in bar.iter(range(5)):
for j in bar.iter(range(10)):
# do some work

from cmdprogress.multi import MultiBar

bar = MultiBar(5,lvl=2)
for x in range(5):
for i in bar.iter(range(10)):
# do some work

from cmdprogress.multi import MultiBar

bar = MultiBar(5,10)
for x in bar:
# x will be the tuple (i,j)
# do some work

Acknowledgements

This project depends on colorama to work in the Windows Command Line
Shoutout to this stack overflow answer