Skip to content

AnnikaV9/lowbar

master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

lowbar

The simplest no-nonsense progress bar for python.

demo

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 customization
  • Extremely low overhead
  • Small package size

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

Usage


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

import lowbar

And initialize the bar:

bar = lowbar.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.update(20)

The above function will immediately move the bar to 20%. To use a more smoother but slower animation:

bar.update_smooth(40)

Note: Since version 1.1.4, update_smooth() is no-longer fully blocking. It will run in a separate thread, so your program will continue it's execution while the bar is animating. However, calling another lowbar function during the animation will block the main thread to prevent visual glitches. To avoid this block, make sure to call log() before update_smooth(), not after. See issue #5


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:

bar = lowbar.lowbar()

completion = 0
bar.new()
for i in range(10):
    time.sleep(2) # This would be replaced with an actual task
    bar.log(f"Task {i+1} completed")
    completion += 10
    bar.update_smooth(completion)
bar.clear()

print("Tasks complete!")

You don't even need a loop:

bar = lowbar.lowbar()

bar.new()
time.sleep(1)
bar.update_smooth(10)
time.sleep(2)
bar.update_smooth(40)
time.sleep(2)
bar.update_smooth(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.lowbar() as bar:
    time.sleep(1)
    bar.update_smooth(10)
    time.sleep(3)
    bar.update_smooth(100)

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.lowbar(range(100)):
    time.sleep(0.5)

To make things even more simpler, you can pass an integer and lowbar will convert it into a range object for you:

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

lowbar will use update() by default when used as an iterable. If you're only going to loop a few times, you can force lowbar to use update_smooth():

for i in lowbar.lowbar(6, smooth_iter=True):
    time.sleep(1)

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.lowbar(bar_load_fill="O", bar_blank_fill=".")

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

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

Note: If the console is too small to accommodate both the bar and the description text, the text will be hidden.


Parameters


  • __init__()   -   Init function thats called when the lowbar object is created.

    • bar_iter: A range object that lowbar will iterate through when __iter__() is called. If an integer is provided, lowbar will automatically convert it into a range object. Default: 0
    • smooth_iter: A boolean switch which forced lowbar to use update_smooth() when iterating. Default: False
    • bar_load_fill: A string of size 1, which will be used to fill the bar as it loads. Default: "#"
    • bar_blank_fill: A string of size 1, which will be used to fill the part of the bar that isn't loaded yet. Default: "-"
    • bar_desc: A string, which will be displayed to the left of the bar. If the console is too small to accommodate both the bar and the desc, the desc will be hidden. Default: ""
    • remove_ends: A boolean switch which will hide the chars placed at both ends of the bar ([ & ]). Default: False
    • no_clear: A boolean switch which will stop lowbar from clearing the bar automatically when used as an iterable or with a context manager. Useful if you want a 'receipt'. Default: False

  • new()   -   Alias for update(0)

  • update()   -   Increases or decreases the completed percentage and refreshes the bar, automatically resizing if the console size has changed.

    • percentage: An integer value to set the completed percentage as. No default value.

  • update_smooth()   -   Same as update(), with a smoother but slower animation. Avoid using this function if execution speed is important for you. The completion percentage cannot be decreased with this function.

    • percentage: An integer value to set the completed percentage as. Must be higher than the currently set value. No default value.

  • log()   -   Logs text to the console without affecting the bar.

    • text: Any string. Any other type needs to be converted with str() before being passed to this function. No default value.

  • clear()   -   Clears the currently running 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


MIT License

Copyright (c) 2022 AnnikaV9

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.