lowbar

The simplest no-nonsense progress bar for python.

lowbar is a blazing fast module with zero dependencies for displaying a progress bar in the terminal. It has a low number of features and a simple codebase, hence the name lowbar.

lowbar has:

• Automatic resizing
• Manual progress management
• Automatic progress management (As an iterable)
• Text logging
• Bar styling
• Low overhead
• Small size ( < 150 lines)

lowbar doesn't have:

• Nested bars
• Fancy animations
• ETA calculations

Requirements

• Python 3.7 or above. lowbar may support earlier versions, but this has not been tested.
• A console that supports line feed \n and carriage return \r.

Installation

Install the latest stable release:

pip install lowbar

Or the development version:

pip install git+https://github.com/AnnikaV9/lowbar

The sections below document the development version in this repository. For the stable release docs, refer to the PyPi page.

Usage

Once you have lowbar installed, you can import it like any other module:

from lowbar import lowbar

And initialize the bar:

bar = lowbar()

To make the bar visible and set at 0%:

bar.new()

After completing some tasks, we can increase the bar's completion percentage:

bar.add(20)

If we have a known number of tasks, lowbar can automatically calculate the percentage for us:

bar.next(tasks)

We can also set the completion percentage instead of adding to it:

bar.update(50)

Using print() or other similar functions will push the bar up, which doesn't look nice. To log messages without affecting the bar:

bar.log("Hello World!")

And finally, to clear the bar completely:

bar.clear()

Here's an example usage of the bar:

tasks = 10
bar.new()
for i in range(tasks):
    time.sleep(2)  # task
    bar.log(f"Task {i+1} completed")
    bar.next(tasks)
bar.clear()

print("Tasks complete!")

You don't even need a loop:

bar.new()
time.sleep(1)  # task
bar.add(10)
time.sleep(2)  # task
bar.add(10)
time.sleep(2)  # task
bar.update(100)
bar.clear()

print("Tasks complete!")

The bar can also be used with a context manager. It will automatically run new() at the start and clear() when exiting:

with lowbar() as bar:
    time.sleep(1)  # task
    bar.add(50)
    time.sleep(3)  # task
    bar.add(50)

print("Tasks complete!")

To make things simpler, you can wrap lowbar around range() and turn it into an iterable. It will automatically calculate how much to increase the percentage by every loop:

for i in lowbar(range(100)):
    time.sleep(0.5)  # task

Pass an integer and lowbar will convert it into a range object for you:

for i in lowbar(100):
    time.sleep(0.5)  # task

[!NOTE] You can't use log() when using lowbar as an iterable.

You can also change the load fill and blank fill chars:

bar = lowbar(load_fill="O", blank_fill=".")

Or add a description text to the left side of the bar:

bar = lowbar(desc="Downloading...")

[!NOTE] If the console is too small to accommodate both the bar and the description text, the text will be hidden.

Reference

__init__()

Called when the lowbar object is created.

new()

Alias for update(0).

update()

Set the completion percentage and refreshes the bar, resizing if the console size changes.

add()

Add to the completion percentage and refreshes the bar, resizing if the console size changes.

next()

Similar to add(), but calculates the percentage to add based on the total number of tasks.

log()

Logs text to the console without affecting the bar.

clear()

Clears the currently active bar.

Contributing

All contributions are welcome!

If you wish to report a bug or suggest a feature, open an issue.

You can also make a pull request directly if you already have the fix for a bug.

See CONTRIBUTING.md for guidelines to follow.

Contributors are listed in CONTRIBUTORS.md.

License

This project is licensed under the MIT License.