Metadata-Version: 2.4
Name: pycoolprogressbar
Version: 0.1.0
Summary: Progress bars with cool ANSI styling! and more!
Author: robert-ish
License-Expression: MIT
Project-URL: Homepage, https://github.com/robert-ish/coolbar
Project-URL: Repository, https://github.com/robert-ish/coolbar
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: yet-another-ansi-lib>=0.1.1
Dynamic: license-file

# coolbar
Aims to be the ultimate progress bar package for python.  
(But i dont believe in myself so it fails)
## Installation
```bash
pip install pycoolprogressbar
```
## Usage
```python
from pycoolprogressbar import CoolBar
import time
for i in CoolBar(100):
    time.sleep(0.02)
```
## CoolBar class
This is the main class for everything
It can be used as an iterable or as a context manager
### __init__ (creating the instance):
This can be kinda confusing?
args:
total: the maximum value of the progress bar. Can be overshot.
width: the length of the progress bar, in characters.
color: must be a color from the COLORS_LIST
fill: changes the character displayed for filled segments.
empty: changes the character displayed for unfilled segments.
prefix: displayed in the bar before the bar. use as a title (eg.: "Loading")
suffix: displayed after the bar but before everything else, surprisingly. Could use to describe what you're doing
start: what value the bar starts from.
done_msg: printed when bar ends with no errors
under_msg: printed when the bar ends without reaching total.
over_msg: printed when the bar ends with current being more than total.
spinner_func: used to add a spinner to the bar. It should be a function, and you should preferably add limiting frames yourself
spinner_max_frames: additional frame limit. it should be how much frames you have - 1
unit: what is displayed when overshot and in the speed counter.
### CoolBar.update(n)
Adds n to the instances current count.
This is also called when calling the coolbar class itself
Can overshoot total.
## License
MIT
