Metadata-Version: 2.1
Name: StringProgressBar
Version: 1.1.1
Summary: Simple string progress bar made for discord bots. Its usable everywhere.
Home-page: https://github.com/MrJacob12/StringProgressBar
Author: MrJacob, Sparker-99
Author-email: jacob@fern.fun
License: MIT
Description: <p align="center">
         <a><img width=270px height=100px src="https://i.gyazo.com/eab981f7ae88b795346f6df4deca80e7.png" alt="Project logo"></a>
        </p>
        
        <h1 align="center">StringProgressBar</h1>
        
        <div align="center">
        
        [![GitHub Issues](https://img.shields.io/github/issues/MrJacob12/StringProgressBar.svg)](https://github.com/MrJacob12/StringProgressBar/issues)
        [![License](https://img.shields.io/github/license/MrJacob12/StringProgressBar.svg)](/LICENSE)
        
        </div>
        
        ## 📝 Table of Contents
        <!-- -  -->
        <!-- - [Deployment](#deployment) -->
        <!-- - [Usage](#usage) -->
        
        - [About](#about)
        - [Getting Started](#getting_started)
        - [Built Using](#built_using)
        - [Authors](#authors)
        
        ## 🧐 About <a name = "about"></a>
        Simple string progress bar made for discord bots. Its usable everywhere.
        
        ### Advantages
        
        * Simple
        * Lightweight
        * Fully customizable
        * 2 Different Styles
        
        ## 🏁 Getting Started <a name = "getting_started"></a>
        
        ### Installing
        
        A step by step series of examples that tell you how to get a development env running.
        
        ```bash
        pip install StringProgressBar
        ```
        
        ## Splitbar Usage <a name="usage"></a>
        
        ![](https://i.ibb.co/5Yz89gM/splitbar.png)
        
        ```python
        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 <a name="usage"></a>
        
        ![](https://i.ibb.co/ctTB8mp/filledbar.png)
        
        ```python
        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 <a name = "built_using"></a>
        * [Python](https://www.python.org)
        
        ## 📝 License
        
        This project is [MIT](https://github.com/MrJacob12/StringProgressBar/blob/master/LICENSE) licensed.
        
        
        ## ✍️ Authors <a name = "authors"></a>
        
        - [@MrJacob12](https://github.com/mrjacob12)
        - [@Sparker-99](https://github.com/Sparker-99)
        
        
        Change Log
        ==========
        
        1.1.0 (26.09.2021)
        -------------------
        - Major update
        
        1.0.0 (12.06.2021)
        -------------------
        - First Release
        
Keywords: String Progress Bar
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
