Skip to content

yannikschaelte/jabbar

Repository files navigation

jabbar

Build status coverage Current version on PyPI Code style: Black

Just Another Beautiful progress BAR (some might replace Beautiful by Boring).

jabbar is a python package implementing a simple progress bar. The output looks like:

75% |█████████████████      | 750/1000

It is lightweight, easy to use and customizable. As a special feature, it gracefully deals with seeing more items than expected, e.g. 1100/1000. Also, it supports unicorns.

Animation of jabbar in use

For very serious work, you may want to try e.g. the slightly more professional tqdm package.

Install

jabbar can be installed from PyPI via your favorite shell:

$ pip install jabbar

or from the latest code on GitHub with:

$ pip install git+https://github.com/yannikschaelte/jabbar.git

Get started

jabbar is quite flexible and can operate in different modes.

jabbar can simply wrap around any iterable to make loops show a little progress bar:

from jabbar import jabbar
for _ in jabbar(range(1000)):
    pass

The updating scheme can also be individually specified:

from jabbar import jabbar
with jabbar(total=1000, width=30) as bar:
    for _ in range(50):
        bar.inc(20)

When usage of a context manager is undesirable, use jabbar.finish() to clean up the output.

Further examples can be found in the example/howto.ipynb notebook.

License

jabbar is available under an MIT license.