Metadata-Version: 2.1
Name: pyprobar
Version: 0.1.1.9
Summary:  An easy-to-use and colorful progress bar for python.
Home-page: https://github.com/beidongjiedeguang/python-progress-bar
Author: K.y
Author-email: beidongjiedeguang@gmail.com
License: MIT
Description: # Pyprobar
        
        [![image](https://img.shields.io/badge/Pypi-0.1.1.9-green.svg)](https://pypi.org/project/pyprobar)
        [![image](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/)
        [![image](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
        [![image](https://img.shields.io/badge/author-K.y-orange.svg?style=flat-square&logo=appveyor)](https://github.com/beidongjiedeguang)
        
        
        
        
        A beautiful , fast, easy-to-use  progress bar for python.
        
        
        ## Installation
        
        ```bash
        pip install pyprobar
        ```
        
        *nightly*  build:
        
        ```bash
        python setup.py install
        ```
        
        
        ## Synopsis
        
        ```bash
        28.71% |████████>>>>>>>>>>>>>>>>>  | 0:00:22|0:00:31 ETC: 05-20 18:08:15
        ```
        
        <img src="picture/color=1.gif" />
        
        <img src="picture/color=5.gif" />
        
        
        
        ## Performance
        
        **For 10000000 loops:**
        
        ```bash
        probar: # this repo
        100.00%|█████████████████████████████| 0:00:00|0:00:02  ETC: 06-07 12:08:03
        
        bar: # this repo
        100.00%|█████████████████████████████| 0:00:00|0:00:03  ETC: 06-07 12:11:15
        
        tqdm:
        100%|██████████| 10000000/10000000 [00:03<00:00, 2634907.84it/s]
        
        progressbar:
        100% (10000000 of 10000000) |############| Elapsed Time: 0:00:46 Time:  0:00:46
        ```
        
        
        
        ## Usage
        
        Use `probar` or `bar` for different situations:
        
        `probar`:
        
          ```python
          from pyprobar import bar, probar
          import time
          
          for idx, x in probar(range(1234), enum=True): 
              time.sleep(0.02)
          ```
          ```bash
          >>> 18.31%|█████>>>>>                  | 0:00:20|0:00:25  ETC: 05-20 19:00:39
          ```
        Or  used in  List comprehension:
        
        ```python
        res = [i for i in probar(range(10))]
        print(res)
        ```
        
        ```bash
        >>> 100.00%|███████████████████████████| 0:00:00|0:00:00 ETC: 05-20 12:14:33
        >>> [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
        ```
        
        
        
        `bar`:
        
          ```python
          import numpy as np
          N = 1024
          a = np.linspace(2, 5, N)
          for idx, i in enumerate(a):
              time.sleep(0.01)
              bar(idx, N)
          ```
          ```bash
         >>> 100.00% |███████████████████████████| 0:00:00|0:00:10  ETC: 05-20 20:33:34 
          ```
        
        
        
        You can set your own progress bar by using the parameters `symbol_1` and `symbol_2` :
        
        ```python
        for i in probar(range(1234), symbol_2="o"):
            time.sleep(0.01)
        ```
        ```bash
        >>> 23.10%|██████ooooooooooooooooooo    | 0:00:10|0:00:14  ETC: 05-20 17:29:57
        ```
        
        Tip: Search`charmap`  in win10 start menu, you can find a lot of interesting characters.
        
        
        
        **Supports progress bars in different colors**:
        
        ```python
        for idx, i in enumerate(a):
            bar(idx, N, color='1') # `color` options: '1','2','3','4','5','0','update_random'
            time.sleep(0.01)
        ```
        
        <img src="picture/color=1.gif" />
        
        
        
        Of course, you can also add text or variables to the progress bar:
        
        ```python
        for idx, i in enumerate(a):
            text = f"what you want see is {x}"
            bar(idx, N, text=text)
        ```
        
        <img src=picture/text.gif />
        
        multi-line text :
        
        ```python
        for idx, i in enumerate(a):
            text = f"{v1}, frame:{idx}\n"
            bar(idx, N, text=text)
        ```
        
        <img src="picture/multi_text.jpg" alt="multi_text" style="zoom:80%;" />
        
        Specify the time zone:
        
        ```python
        for i in enumerate(a):
            bar(idx, N, time_zone="Asia/Shanghai")
        ```
        
        
        
        print RGB color string:
        
        ```python
        from pyprobar.styleString import rgb_str
            text = rgb_str("I'm green!", RGB_fore=[0,255,0])
            print(text)
        ```
        
        <img src=picture/rgb_str.jpg />
        
        
        
        ### TODO
        
        - [x] Thread problem with probar()  in jupyter notebook
        - [ ] Thread  problem with `bar()`  in jupyter notebook
        - [ ] Speed of information
        - [ ] Multithreading
        
        
        
        
Keywords: Python Utilities,Machine Learning
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
