Metadata-Version: 2.1
Name: cs.upd
Version: 20200517
Summary: Single line status updates with minimal update sequences.
Home-page: https://bitbucket.org/cameron_simpson/css/commits/all
Author: Cameron Simpson
Author-email: cs@cskk.id.au
License: GNU General Public License v3 or later (GPLv3+)
Description: Single line status updates with minimal update sequences.
        
        *Latest release 20200517*:
        * Multiline support!
        * Multiline support!
        * Multiline support!
        * New UpdProxy class to track a status line of a multiline Upd in the face of further inserts and deletes.
        * Upd(...) now returns a context manager to clean up the display on its exit.
        * Upd(...) is now a SingletonMixin in order to use the same state if set up in multiple places.
        
        This is available as an output mode in `cs.logutils`.
        
        Example:
        
            with Upd() as U:
                for filename in filenames:
                    U.out(filename)
                    ... process filename ...
                    upd.nl('an informational line')
        
        ## Function `cleanupAtExit()`
        
        Cleanup function called at programme exit to clear the status line.
        
        ## Class `Upd(cs.obj.SingletonMixin)`
        
        A `SingletonMixin` subclass for maintaining a regularly updated status line.
        
        ## Class `UpdProxy`
        
        A proxy for a status line of a multiline `Upd`.
        
        This provides a stable reference to a status line after it has been
        instantiated by `Upd.insert`.
        
        The status line can be accessed and set via the `.text` property.
        
        # Release Log
        
        
        
        *Release 20200517*:
        * Multiline support!
        * Multiline support!
        * Multiline support!
        * New UpdProxy class to track a status line of a multiline Upd in the face of further inserts and deletes.
        * Upd(...) now returns a context manager to clean up the display on its exit.
        * Upd(...) is now a SingletonMixin in order to use the same state if set up in multiple places.
        
        *Release 20200229*:
        * Upd: can now be used as a context manager, clearing the line on exit.
        * Upd.without is now a context manager, returning the older state, and accepting an optional inner state (default "").
        * Upd is now a singleton factory, obsoleting upd_for.
        * Upd.nl: use "insert line above" mode if supported.
        
        *Release 20181108*:
        Documentation improvements.
        
        *Release 20170903*:
        * New function upd_for(stream) returning singleton Upds.
        * Drop noStrip keyword argument/mode - always strip trailing whitespace.
        
        *Release 20160828*:
        * Use "install_requires" instead of "requires" in DISTINFO.
        * Add Upd.flush method.
        * Upd.out: fix longstanding trailing text erasure bug.
        * Upd.nl,out: accept optional positional parameters, use with %-formatting if supplied, just like logging.
        
        *Release 20150118*:
        metadata fix
        
        *Release 20150116*:
        Initial PyPI release.
Keywords: python2,python3
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Description-Content-Type: text/markdown
