Progress Indicators for Python

GitHub Page: flamechain/ConsLoadingBar

Full Docs: flamechain/ConsLoadingBar/Documentation.md

Backwards Compatible Since 3.0.0

Note: Please report bugs, give feedback, and make suggestions on my github page

Import

Imported simply:

import consloadingbar, time # time import is not required, but will be used for eta calculation later

Built-In Demo

You can use demo.py, or call SimulateTasks() to see another bult-in demo class. You can read more about how this class works in the full docs here.

clb = consloadingbar.SimulateTasks()

Progress Indicators

There are 4 indicators to choose from:

• progressBar
• progressChar
• spinner
• counter

ProgressBar()

Global Params

Local Params

You can use the params from Bar() to customize the look of the bar (see demo) and the params from the method for iter-specific things like current percentage.

clb = consloadingbar.Bar(useColor=True, taskCount=10)

start = time.time()

for i in range(101):
    currentTime = time.time() - start
    # Do something. For demo purposes you can sleep the program for about 0.01 seconds.
    clb.progressBar(i, time_=currentTime, tasksDone=i//10)

This will display tasks and eta. You can also call the start() method for multiline titles:

clb.start()

Running...
        |                    |   0%  [tasks=0/10]

Or you can use the end() method to show a full bar. This example has useColor enabled.

clb.end()

Finished
        |████████████████████| 100%  [tasks=10/10]

ProgressChar()

This shows a character for progress. Like spinner but has a sense of completion.

clb = consloadingbar.Bar()

clb.progressChar(1) # Will run for 2 seconds

Loading ▁

Spinner()

As seen in the demo, you can do lots. Here are a couple examples that are shown in the demo:

clb = consloadingbar.Bar()

clb.spinner(time_=2)

clb.spinner(time_=4.7, phases='preset')

This last one uses a preset, and the preset takes about 4.7 seconds to complete once.

Counter()

Here is how to count up and count down in 2 seconds each:

clb = consloadingbar.Bar()

clb.counter(2, start=0, end=100)
clb.counter(2, start=100, end=0)

This will count up to 100, then back down to 0

Installation

Install via pip using pip install ConsLoadingBar.

pip install ConsLoadingBar

To make sure you have the current version you can use this command instead:

pip install --upgrade ConsLoadingBar

You can also directly call the module from python:

python3 -m pip install ConsLoadingBar

License

ConsLoadingBar is licensed under the MIT License