Metadata-Version: 1.2
Name: enlighten
Version: 1.5.1
Summary: Enlighten Progress Bar
Home-page: https://github.com/Rockhopper-Technologies/enlighten
Author: Avram Lubkin
Author-email: avylove@rockhopper.net
Maintainer: Avram Lubkin
Maintainer-email: avylove@rockhopper.net
License: MPLv2.0
Project-URL: Documentation, https://python-enlighten.readthedocs.io
Description: .. start-badges
        
        | |docs| |travis| |codecov|
        | |pypi| |supported-versions| |supported-implementations|
        | |linux| |windows| |mac| |bsd|
        | |fedora| |EPEL|
        
        .. |docs| image:: https://img.shields.io/readthedocs/python-enlighten.svg?style=plastic&logo=read-the-docs
            :target: https://python-enlighten.readthedocs.org
            :alt: Documentation Status
        
        .. |travis| image:: https://img.shields.io/travis/Rockhopper-Technologies/enlighten.svg?style=plastic&logo=travis
            :target: https://travis-ci.org/Rockhopper-Technologies/enlighten
            :alt: Travis-CI Build Status
        
        .. |codecov| image:: https://img.shields.io/codecov/c/github/Rockhopper-Technologies/enlighten.svg?style=plastic&logo=codecov
            :target: https://codecov.io/gh/Rockhopper-Technologies/enlighten
            :alt: Coverage Status
        
        .. |pypi| image:: https://img.shields.io/pypi/v/enlighten.svg?style=plastic&logo=pypi
            :alt: PyPI Package latest release
            :target: https://pypi.python.org/pypi/enlighten
        
        .. |supported-versions| image:: https://img.shields.io/pypi/pyversions/enlighten.svg?style=plastic&logo=pypi
            :alt: Supported versions
            :target: https://pypi.python.org/pypi/enlighten
        
        .. |supported-implementations| image:: https://img.shields.io/pypi/implementation/enlighten.svg?style=plastic&logo=pypi
            :alt: Supported implementations
            :target: https://pypi.python.org/pypi/enlighten
        
        .. |linux| image:: https://img.shields.io/badge/Linux-yes-success?style=plastic&logo=linux
            :alt: Linux supported
            :target: https://pypi.python.org/pypi/enlighten
        
        .. |windows| image:: https://img.shields.io/badge/Windows-yes-success?style=plastic&logo=windows
            :alt: Windows supported
            :target: https://pypi.python.org/pypi/enlighten
        
        .. |mac| image:: https://img.shields.io/badge/MacOS-yes-success?style=plastic&logo=apple
            :alt: MacOS supported
            :target: https://pypi.python.org/pypi/enlighten
        
        .. |bsd| image:: https://img.shields.io/badge/BSD-yes-success?style=plastic&logo=freebsd
            :alt: BSD supported
            :target: https://pypi.python.org/pypi/enlighten
        
        .. |fedora| image:: https://img.shields.io/badge/dynamic/json.svg?uri=https://pdc.fedoraproject.org/rest_api/v1/component-branches/?global_component=python-enlighten;fields=name;active=true;type=rpm&query=$.results[?(@.name.startsWith(%22f%22))].name&label=Fedora&colorB=lightgray&style=plastic&logo=fedora
            :alt: Fedora version support
            :target: https://bodhi.fedoraproject.org/updates/?packages=python-enlighten
        
        .. |EPEL| image:: https://img.shields.io/badge/dynamic/json.svg?uri=https://pdc.fedoraproject.org/rest_api/v1/component-branches/?global_component=python-enlighten;fields=name;active=true;type=rpm&query=$.results[?(@.name.startsWith(%22e%22))].name&label=EPEL&colorB=lightgray&style=plastic&logo=epel
            :alt: EPEL version support
            :target: https://bodhi.fedoraproject.org/updates/?packages=python-enlighten
        
        .. end-badges
        
        Overview
        ========
        
        Enlighten Progress Bar is a console progress bar module for Python. (Yes, another one.)
        
        The main advantage of Enlighten is it allows writing to stdout and stderr without any
        redirection.
        
        .. image:: https://raw.githubusercontent.com/Rockhopper-Technologies/enlighten/master/doc/_static/demo.gif
        
        Documentation
        =============
        
        https://python-enlighten.readthedocs.io
        
        Installation
        ============
        
        PIP
        ---
        
        .. code-block:: console
        
            $ pip install enlighten
        
        EL6 and EL7 (RHEL/CentOS/Scientific)
        ------------------------------------
        
        (EPEL_ repositories must be configured_)
        
        .. code-block:: console
        
            $ yum install python-enlighten
        
        Fedora
        ------
        
        .. code-block:: console
        
            $ dnf install python2-enlighten
            $ dnf install python3-enlighten
        
        
        Examples
        ========
        
        Basic
        -----
        
        For a basic status bar, invoke the Counter_ class directly.
        
        .. code-block:: python
        
            import time
            import enlighten
        
            pbar = enlighten.Counter(total=100, desc='Basic', unit='ticks')
            for num in range(100):
                time.sleep(0.1)  # Simulate work
                pbar.update()
        
        Advanced
        --------
        
        To maintain multiple progress bars simultaneously or write to the console, a manager is required.
        
        Advanced output will only work when the output stream, ``sys.stdout`` by default,
        is attached to a TTY. get_manager_ can be used to get a manager instance.
        It will return a disabled Manager_ instance if the stream is not attached to a TTY
        and an enabled instance if it is.
        
        .. code-block:: python
        
            import time
            import enlighten
        
            manager = enlighten.get_manager()
            ticks = manager.counter(total=100, desc='Ticks', unit='ticks')
            tocks = manager.counter(total=20, desc='Tocks', unit='tocks')
        
            for num in range(100):
                time.sleep(0.1)  # Simulate work
                print(num)
                ticks.update()
                if not num % 5:
                    tocks.update()
        
            manager.stop()
        
        Counters
        --------
        
        The Counter_ class has two output formats, progress bar and counter.
        
        The progress bar format is used when a total is not ``None`` and the count is less than the
        total. If neither of these conditions are met, the counter format is used:
        
        .. code-block:: python
        
            import time
            import enlighten
        
            counter = enlighten.Counter(desc='Basic', unit='ticks')
            for num in range(100):
                time.sleep(0.1)  # Simulate work
                counter.update()
        
        
        Additional Examples
        -------------------
        * `basic <https://raw.githubusercontent.com/Rockhopper-Technologies/enlighten/master/examples/basic.py>`__ - Basic progress bar
        * `context manager <https://raw.githubusercontent.com/Rockhopper-Technologies/enlighten/master/examples/context_manager.py>`__ - Managers and counters as context managers
        * `floats <https://raw.githubusercontent.com/Rockhopper-Technologies/enlighten/master/examples/floats.py>`__ - Support totals and counts that are ``floats``
        * `multicolored <https://raw.githubusercontent.com/Rockhopper-Technologies/enlighten/master/examples/multicolored.py>`__ - Multicolored progress bars
        * `multiple with logging <https://raw.githubusercontent.com/Rockhopper-Technologies/enlighten/master/examples/multiple_logging.py>`__ - Nested progress bars and logging
        * `FTP downloader <https://raw.githubusercontent.com/Rockhopper-Technologies/enlighten/master/examples/ftp_downloader.py>`__ - Show progress downloading files from FTP
        
        Customization
        -------------
        
        Enlighten is highly configurable. For information on modifying the output, see the
        Series_ and Format_ sections of the Counter_ documentation.
        
        .. _Counter: http://python-enlighten.readthedocs.io/en/stable/api.html#enlighten.Counter
        .. _Manager: http://python-enlighten.readthedocs.io/en/stable/api.html#enlighten.Manager
        .. _get_manager: http://python-enlighten.readthedocs.io/en/stable/api.html#enlighten.get_manager
        .. _Format: http://python-enlighten.readthedocs.io/en/stable/api.html#counter-format
        .. _Series: http://python-enlighten.readthedocs.io/en/stable/api.html#series
        .. _EPEL: https://fedoraproject.org/wiki/EPEL
        .. _configured: https://fedoraproject.org/wiki/EPEL#How_can_I_use_these_extra_packages.3F
        
Keywords: progress,bar,progressbar,counter,status,statusbar
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
