https://github.com/slok/pygressbar
Flexible and customizable python progress bar
https://github.com/slok/pygressbar
Last synced: 2 months ago
JSON representation
Flexible and customizable python progress bar
- Host: GitHub
- URL: https://github.com/slok/pygressbar
- Owner: slok
- Created: 2012-10-12T16:48:45.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2013-12-26T17:55:35.000Z (almost 12 years ago)
- Last Synced: 2025-04-05T02:11:18.460Z (6 months ago)
- Language: Python
- Size: 151 KB
- Stars: 26
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
PygressBar
==========
[](http://travis-ci.org/slok/pygressbar)
Description
-----------
PygressBar is a progressbar utility for our command line tools,
scripts... Some of features:
* Different flavours with premade bars
* Extensible
* Customizable bars
* Fast and easy usage
* Terminal bar animation compatible (wget style)
* Python 3 compatible
Requirements
------------
* Python >=2.7 or Python 3
Bar flavours
-----------
###Simple bar###
The simple bar is a bar that its head is `>` its body area is `=` and
the empty area is ` `. It's length always is 20. Example
[==============> ]
###Custom bar###
The custom bar, is a bar that can be customized in all the ways.
* Left and right limits
* Lenght
* Fill char
* Empty char
* Head
* Format
* Scale (for increase and decrease)
* Start point
Some examples:
(==============#..................................)
|#####@-----------|
#------->**************#
||||||||||||||||||||||_________
###Simple percent bar###
The simple percent bar is the same as the simple bar, but in the right side
has the numeric percent progress. Example
[===================>](100%)
[> ](5%)
[=========> ](54%)
[======> ](36%)
[===========> ](63%)
###Simple Animated bar###
The animated bar animates the head. The animation is created with a tuple.
By default will be the classic spinner: `|`, `/`, `-`, `\`. Also it has the
attribute `speed` that is the speed between 0 (slowest) and 2000 (the highest).
The spinner speed animation is something tricky and depends on the printed (or
getted) times, so it's recommended to test the best speed for your needs.
Example:
[=========| ]
[=========/ ]
[=========- ]
[=========\ ]
[=========| ]
###Simple Color bar###
The simple color bar is the same bar as the simple bar but with colors (ANSI
terminal colors: http://en.wikipedia.org/wiki/ANSI_escape_code#Colors). To
customize the colors, each part has a property: `left_limit_clr`,
`right_limit_clr`, `head_clr`, `filled_clr`, `empty_clr` Pygressbar comes with
various colors: `RED`, `BLUE`, `GREEN`, `MAGENTA`, `WHITE`, `COL_RESET`,
`YELLOW` and `CYAN`
Example:
![Pygressbar in action](https://gist.github.com/slok/3885420/raw/b0b754ada28a3b9bd5ead6e6edb9cec18d402ecc/pygress_color.png"Pygressbar in action")
Usage
-----
The usage is very simple. Create an instance of the bar that you want:
>>> bar = SimpleProgressBar()
Now we can obtain the progress of the bar
>>> bar.progress
0
And increase and decrease
>>> bar.increase(50)
>>> bar.progress
50
>>> bar.decrease(3)
>>> bar.progress
47
If we want we can obtain the progress bar representation
>>> bar.progress_bar
'[========> ]'
If we want to animate the bar in the terminal, we can print it directly. This
allows to animate if we don't print nothing more after printing this.
>>> bar.show_progress_bar()
[========> ]
Example
-------
Download a big txt file (12 MB):
```python
def download_file():
big_file_url = "https://gist.github.com/raw/3885120/803c00" +\
"b809c7a9c4a44626320374d18933b63b48/big.txt"
# Download the file
if sys.version_info[0] == 3:
f = urllib.request.urlopen(big_file_url)
else:
f = urllib.urlopen(big_file_url)
# Get the total length of the file
scale = int(f.headers["content-length"])
chunk_size = 500
bar = CustomProgressBar(length=50,
left_limit='[',
right_limit=']',
head_repr=None,
empty_repr=' ',
filled_repr='|',
start=0,
scale_start=0,
scale_end=scale)
print("Downloading a big txt file: ")
print_flag = 0
# Load all the data chunk by chunk
while not bar.completed():
f.read(chunk_size)
bar.increase(chunk_size)
# Don't print always
if print_flag == 100:
bar.show_progress_bar()
print_flag = 0
else:
print_flag += 1
bar.show_progress_bar()
print("")
print("Finished :)")
```
Author
------
Xabier (slok) Larrakoetxea - (slok69 [at] gmail.com)
License
-------
3 clause/New BSD license:
[opensource](http://www.opensource.org/licenses/BSD-3-Clause),
[wikipedia](http://en.wikipedia.org/wiki/BSD_licenses)