Simple string progress bar made for discord bots. Its usable everywhere.
Project description
StringProgressBar
📝 Table of Contents
🧐 About
Simple string progress bar made for discord bots. Its usable everywhere.
Advantages
- Simple
- Lightweight
- Fully customizable
- 2 Different Styles
🏁 Getting Started
Installing
A step by step series of examples that tell you how to get a development env running.
pip install StringProgressBar
Splitbar Usage
from StringProgressBar import progressBar
# Assaign values to total and current values
total = 100
current = 50
# First two arguments are mandatory
bardata = progressBar.splitBar(total, current, [optional parameters])
# Get the progressbar
print(bardata[0])
# Get the percentage
print(bardata[1])
Filledbar Usage
from StringProgressBar import progressBar
# Assaign values to total and current values
total = 100
current = 50
# First two arguments are mandatory
bardata = progressBar.filledBar(total, current, [optional parameters])
# Get the progressbar
print(bardata[0])
# Get the percentage
print(bardata[1])
Optional Parameters
| Parameter name | Type | Default | Description |
|---|---|---|---|
| size | Integer | 40 | Determines the length of the bar |
| line | String | ▬ and □ | Determines the Static part of the bar |
| slider | String | 🔘 and ■ | Determines the Progressive part of the bar |
⛏️ Built Using
📝 License
This project is MIT licensed.
✍️ Authors
Change Log
1.1.0 (26.09.2021)
- Major update
1.0.0 (12.06.2021)
- First Release
