candy-bar 1.2.5

A simple progress bar with the ILoveCandy style

CandyBar

A Progress Bar inspired by Arch pacman with ILoveCandy option enabled.

Instalation

Python

Manual instalation

Clone the repository, build, and install the package:

git clone https://github.com/MacDumi/CandyBar.git
cd CandyBar
pip install .

Install from PyPi

pip install candy_bar

C++

Don't like Python? Use it with C++! Clone the repository and copy the files to the search path of your compiler:

git clone https://github.com/MacDumi/CandyBar.git
cd CandyBar
cp src/candybar.* <search_path>

Usage

Import the package and create the progress bar object:

# Python
from candy_bar import CandyBar

cb = CandyBar(100, "Progress")

// C++
#include "candybar.h"

...

CandyBar cb(100, "Progress");

Parameters

Parameter	Default	Description
total	100	Defines the value corresponding to 100%
message	None	Write some text at the beginning of the line
width	console size	Size (in chars) of the bar, by default max console size
left_justified	True	Defines the justification of the bar (not the message text)

To update the position of the progress bar use the update method:

# Python
total = 100

for i in range(total + 1):
    # Your code goes here
    cb.update(i)

// C++
int total = 100;

for (int i = 0; i <= total; i++)
{
    // Your code goes here
    cb.update(i);
}

The total value, the message, and the justification of the progress bar can be changed:

# Python
cb.set_total(150)
cb.set_message("Another message")
cb.set_left_justified(False)

// C++
cb.set_total(150);
cb.set_message("Another message");
cb.set_left_justified(false);

Like what I do?

Buy me coffee 85jJPcfLPZRUKm3Re6qHZsKBZskVS2tYMWFoY5sYXUSQJzqzqpuPFepXMtqTKCRfuhYXaiJ3zQVeRPDYJUfepVjnJDpApH5