semvec/pypi-packages huggingface dataset:
string-bar 0.0.1
A simple string progressbar package
Requires Python: >=3.8

# String Bar
String Bar is a simple progress bar generator. Main purpose of this module is to be used in discord bots that written with Python but it generates a string so it can be used everywhere.
	***[the repository I got the idea from](https://github.com/Sparker-99/string-progressbar)***
## Bar Types
* Point Bar ```â–¬â–¬â–¬â–¬â–¬â–¬â–¬â–¬â–¬â–¬â–¬ğŸ”˜â–¬â–¬â–¬â–¬â–¬â–¬â–¬â–¬â–¬â–¬â–¬ ```
* Line Bar ```â¬›â¬›â¬›â¬›â¬›â¬œâ¬œâ¬œâ¬œâ¬œ```
## Installation
```py
pip install string-bar
```

## Usage

```py
from string_bar import bar

# Point bar
# total and current arguments are mandatory
# size (length of bar) default to 40, line default to "â–¬" and slider default to "ğŸ”˜"
bar.pointbar(total=100, current=40, size=10, line="â–¬", slider="ğŸ”˜")

# Line bar
# total and current arguments are mandatory
# size (length of bar) default to 40, line default to "â¬›" and blankline default to "â¬œ"
bar.linebar(total=100, current=65, size=10, line="â¬›" , blankline="â¬œ")
```
**Note:** It returns a list containing two elements first one being the bar and second one being the percentage so you need add [0] for the bar and [1] for the percentage. Example: ```bar.pointbar(100, 50)[0]```
## Extra
I recommend using custom emotes with linebar if you're going to be using this module in Discord.
![line](https://cdn.discordapp.com/emojis/759726552400789525.png?v=1)
![blank line](https://cdn.discordapp.com/emojis/759726663893385237.png?v=1)

To use a custom emote you need to get its name and id.

![Getting ID and Name](https://cdn.discordapp.com/attachments/703225131958403123/772116921427820544/2020-10-31_17-30-29.gif)
```py
bar.linebar(100, 50, 10, line="<:asd:771839638830579712>", blankline="<:qwe:771839638665953290>")
```
## Preview
![asd](https://cdn.discordapp.com/attachments/703225131958403123/772142111461736468/Screenshot_2020-10-31_19-56-39.png)
## License
[MIT](https://github.com/bmodb/string-bar/blob/master/LICENSE)