semvec/pypi-packages huggingface dataset:
pyloading-bar 0.0.2
A python loading bar to use in terminal applications
Requires Python: >=3.8

# Pyloading  

## How to install  

Just use pip:  
  
```bash
$ pip install pyloading-bar==0.0.2
```  
  
## How to use  

For now pyloading_bar is a very simple package to draw a simple progress bar in the terminal:

There's two versions of the bar. The Bar (most simple version of the bar):

```python
from pyloading_bar import Bar

number_of_steps = 2
bar = Bar(number_of_steps)
# do something
bar.next()
# do something
bar.next()
```

The usual bar is like this:  
[##########]  

And the RangeBar, this object is created to be used just like an interator on the for loop:

```python
from pyloading_bar import RangeBar

for i in RangeBar(10):
  print(i)
```

You can chage the bar by the symbol parameter:

```python
from pyloading_bar import RangeBar
  
number_of_steps = 10
for step in RangeBar(number_of_steps, symbol='@'):
  print(step)
```

now the bar look like this:  
[@@@@@@@@@@]

or a full string and it'll iterate thru the string to display inner steps:

```python
from pyloading_bar import RangeBar
  
number_of_steps = 10
for step in RangeBar(number_of_steps, symbol='▁▂▃▄▅▆▇█'):
  print(step)
```
now the bar look like this:  
[█▇        ]

if you want to change the walls of the bar, you can use the template parameter:
with the template you *MUST* use some char at the begining and at the end of the bar.

```python
from pyloading_bar import RangeBar
  
number_of_steps = 10
for step in RangeBar(number_of_steps, template='|▁▂▃▄▅▆▇█|'):
  print(step)
```
now the bar look like this:  
|█▇        |

And if you want that the terminal don't update the last line with the new progress bar state (the progress bar assume by default that you don't print anything to the terminal), just say to the progress bar print a new line to each step:

```python
from pyloading_bar import Bar

# The paramenter "symbol" change the character used into the loading bar
number_of_steps = 10
for step in RangeBar(number_of_steps, symbol='@', update_terminal=False):
  print(step)
```

## Contributors  

<a href="https://github.com/NalbertLeal/pyloading_bar/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=NalbertLeal/pyloading_bar" />
</a>

Made with [contrib.rocks](https://contrib.rocks).