Metadata-Version: 1.2
Name: jabbar
Version: 0.0.8
Summary: Just Another Beautiful progress BAR
Home-page: https://github.com/yannikschaelte/jabbar
Author: Yannik Schaelte
Author-email: yannik.schaelte@gmail.com
Maintainer: Yannik Schaelte
Maintainer-email: yannik.schaelte@gmail.com
License: MIT
Download-URL: https://github.com/yannikschaelte/jabbar/releases
Project-URL: Bug Tracker, https://github.com/yannikschaelte/jabbar/issues
Project-URL: Source Code, https://github.com/yannikschaelte/jabbar
Project-URL: Documentation, https://github.com/yannikschaelte/jabbar
Description: jabbar
        ======
        
        |build| |coverage| |pypi|
        
        Just Another Beautiful progress BAR (some might replace Beautiful by Boring).
        
        jabbar is a python package implementing a simple progress bar. The output
        looks like:
        
        .. code-block:: sh
        
           75% |█████████████████      | 750/1000
        
        It is lightweight, easy to use and customizable.
        As a special feature, it gracefully deals with seeing more items than expected, e.g. 1100/1000.
        
        Install
        -------
        
        jabbar can be installed from `PyPI <https://pypi.org/project/jabbar>`_ via your favorite shell:
        
        .. code-block:: sh
        
           $ pip install jabbar
        
        or from the latest code on `GitHub <https://github.com/yannikschaelte/jabbar>`_ with:
        
        .. code-block:: sh
        
           $ pip install git+https://github.com/yannikschaelte/jabbar.git
        
        
        Get started
        -----------
        
        jabbar is quite flexible and can operate in different modes.
        
        jabbar can simply wrap around any iterable to make loops show a little progress
        bar:
        
        .. code-block:: python
        
           from jabbar import jabbar
           for _ in jabbar(range(1000)):
               pass
        
        The updating scheme can also be individually specified:
        
        .. code-block:: python
        
           from jabbar import jabbar
           with jabbar(total=1000, width=30) as bar:
               for _ in range(50):
                   bar.inc(20)
        
        When usage of a context manager is undesirable, use ``jabbar.finish()`` to clean up the output.
        
        
        License
        -------
        
        jabbar is available under a MIT license.
        
        
        .. |build| image:: https://github.com/yannikschaelte/jabbar/workflows/CI/badge.svg
           :target: https://github.com/yannikschaelte/jabbar/actions
           :alt: Build status
        
        
        .. |coverage| image:: https://codecov.io/gh/yannikschaelte/jabbar/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/yannikschaelte/jabbar
        
        
        .. |pypi| image:: https://img.shields.io/pypi/v/jabbar.svg
           :target: https://pypi.org/project/jabbar/
           :alt: Current version on PyPI
        
Keywords: Progress bar,Status bar,Jabberwocky
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7
