Metadata-Version: 2.0
Name: console-progressbar
Version: 1.0.2
Summary: A simple progress bar for console
Home-page: https://github.com/bozoh/console_progressbar
Author: Carlos Alexandre S. da Fonseca
Author-email: carlos.alexandre@outlook.com
License: MIT
Description-Content-Type: UNKNOWN
Keywords: progressbar console
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Utilities
Requires-Python: >=3.5
Provides-Extra: dev
Requires-Dist: check-manifest; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'

.. image:: https://api.travis-ci.org/bozoh/console_progressbar.svg?branch=master
    :target: https://travis-ci.org/bozoh/console_progressbar

====================
Console Progress Bar
====================

It's a very tiny lib to help devs to print a progress bar in console

Usage
=====

Here a very simple sample:

::

    import time
    from console_progressbar import ProgressBar

    pb = ProgressBar(total=100,prefix='Here', suffix='Now', decimals=3, length=50, fill='X')
    pb.print_progress_bar(2)
    time.sleep(5)
    pb.print_progress_bar(25)
    time.sleep(5)
    pb.print_progress_bar(50)
    time.sleep(5)
    pb.print_progress_bar(95)
    time.sleep(5)
    pb.print_progress_bar(100)


Parameters Description
----------------------

params::

    total       - Required  : total iterations (Int)
    prefix      - Optional  : prefix string (Str)
    suffix      - Optional  : suffix string (Str)
    decimals    - Optional  : positive number of decimals in percent complete (Int)
    length      - Optional  : character length of bar (Int)
    fill        - Optional  : bar fill character (Str)


