progbarr 2.0.0

Progbarr is a Python library for creating highly performant and customizable progress bars in the console.

Progbarr

Progbarr is a Python library for creating highly performant and customizable progress bars in the console.

Features

• Supports filling with any UNICODE character
• Supports setting foreground & background colors
  • by name (e.g., green),
  • by HEX (e.g., #ff00ff), or
  • by RGB (e.g., 128,0,128)
• Minimal performance overhead

Installation

pip install progbarr

Usage

Syntax

from progbarr import ProgressBar

with ProgressBar(message, tasks, length, chars, color, bgcolor) as pb:
    for _ in range(tasks):
      # Perform some task
      pb.advance()

The table below explains the constructor parameters:

Parameter	Type	Description	Tip
message	str	What is being done?	Use present participle form
tasks	int	Number of tasks	Must equal loop iterations
length	int	Bar length	Must be a factor of tasks
chars	str	Bar characters	border + fill + head + empty + border
color	str / None	Foreground color	Use None for terminal default
bgcolor	str / None	Background color	Use None for terminal default

Example (Classic)

from time import sleep
from progbarr import ProgressBar

with ProgressBar("Sleeping", 20, 20, "[## ]", None, None) as pb:
    for _ in range(20):
        sleep(0.35)
        pb.advance()

More Examples

NB: The following example progress bars simulate the same tasks as the classic example above.

1. Block

with ProgressBar("Sleeping", 20, 20, "│   │", None, "orange") as pb: ...

2. Circles

with ProgressBar("Sleeping", 20, 20, " ●●○ ", "crimson", None) as pb: ...

3. Squares

with ProgressBar("Sleeping", 20, 20, " ◼◼◻ ", "teal", None) as pb: ...

4. Track

with ProgressBar("Sleeping", 20, 20, " ―⚈― ", "darkgrey", None) as pb: ...

License

This project is licensed under the MIT License – see the LICENSE file for details.