printbuddies 0.4.0

Handful of utilities to do printing tricks to the terminal.

printBuddies

A few utilities to do terminal printing tricks.
Install with:

pip install printBuddies

Contains one class and three functions: ProgBar, printInPlace, ticker, and clear.

ProgBar is a self-incrementing, dynamically sized progress bar.
The progress counter and completion values can be manually overriden if desired.
The width of the progress bar is set according to a ratio of the terminal width so it will be resized automatically if the terminal width is changed.
The display function has a 'returnObject' parameter, allowing ProgBar to be used in comprehensions.
Basic usage:

from printBuddies import ProgBar
total = 100
progBar = ProgBar(total=total-1)
for _ in range(total):
    progBar.display()
progBar.reset()
myList = [progBar.display(returnObject=i) for i in range(total)]

printInPlace erases the current line in the terminal and then writes the value of the 'string' param to the terminal.

from printBuddies import printInPlace
import time
#This will print numbers 0-99 to the terminal with each digit overwriting the last.
for i in range(100):
    printInPlace(i)
    time.sleep(0.1)

ticker prints a list of strings to the terminal with empty lines above and below such that previous text in the terminal is no longer visible.
Visually, It functions as a multi-line version of printInPlace.

from printBuddies import ticker
import time
#This will produce visually the same output as the above example
for i in range(100):
    ticker([i])
    time.sleep(0.1)

A call to clear() simply clears the current line from the terminal.