logging-spinner: non-intrusive spinner for Python

.. image:: https://badge.fury.io/py/logging-spinner.svg :target: https://pypi.python.org/pypi/logging-spinner :alt: Latest PyPI version

.. image:: https://travis-ci.org/dahlia/logging-spinner.svg :alt: Build Status :target: https://travis-ci.org/dahlia/logging-spinner

.. image:: sample.gif :alt: Demo session

This library helps to display loading spinners in CLI in non-intrusive manner. Applications/libraries don't have to depend on any third-party API, but only need to log loading messages through Python's standard logging library:

.. code-block:: python

logger = logging.getLogger('myapp.logger') logger.info('Loading data...', extra={'user_waiting': True})

some long taking process goes here...

logger.info('Finished loading!', extra={'user_waiting': False})

At the outest code of the application, setup a SpinnerHandler:

.. code-block:: python

from logging_spinner import SpinnerHandler

logger = logging.getLogger('myapp') logger.setLevel(logging.INFO) logger.addHandler(SpinnerHandler())

SpinnerHandler is only aware of log records with user_waiting extra field and displays them with a spinner.

See also sample.py <sample.py>_ code.

Author and license

Written by Hong Minhee__ and distributed under GPLv3_ or later.

__ https://hongminhee.org/ .. _GPLv3: https://www.gnu.org/licenses/gpl-3.0.html

Changelog

Version 0.2.2

Released on June 22, 2017.

• Fixed a ValueError raised when a log record with {'user_waiting': Flase} is made without any previous log records with {'user_waiting': True}.

Version 0.2.1

Released on May 21, 2017.

• Fixed a bug that SpinerHandler had crashed when user_waiting log records show a spinner again after a previous spinner was hidden.

Version 0.2.0

Released on May 21, 2017.

• logging_spinner.UserWaitingFilter was introduced to avoid duplicate prints of a log record with user_waiting extra field.

Version 0.1.0

Released on May 21, 2017. The initial release.