Metadata-Version: 1.1
Name: tbvaccine
Version: 0.0.2
Summary: A utility that cures the horrible traceback displays in Python, making them more readable.
Home-page: https://github.com/skorokithakis/tbvaccine/
Author: Stavros Korokithakis
Author-email: hi@stavros.io
License: MIT
Description: TBVaccine
        ---------
        
        TBVaccine is a utility that pretty-prints Python tracebacks. It automatically
        highlights lines you care about and deemphasizes lines you don't, and colorizes
        the various elements in a traceback to make it easier to parse, like so:
        
        .. image:: misc/screenshot.png
        
        Installation
        ============
        
        To install, use ``pip``::
        
            pip install tbvaccine
        
        You are done!
        
        
        Usage as a command-line utility
        ===============================
        
        TBVaccine can be used from the command line. Just pipe STDERR into it from the
        program you want to watch::
        
            ./myscript.py 2>&1 | tbvaccine
        
        And all the tracebacks will now be pretty!
        
        
        Usage as a Python library
        =========================
        
        There are various ways to use TBVaccine as a Python library.
        
        Initialize it like so::
        
            from tbvaccine import TBVaccine
            tbv = TBVaccine(
                code_dir="/my/code/dir",
                isolate=True
            )
        
        ``code_dir`` marks the directory we code about. Files under that directory that
        appear in the traceback will be highlighted. If not passed, the current
        directory, as returned by ``os.getcwd()`` will be used.
        
        If ``isolate`` is ``False``, all lines are colorized, and ``code_dir`` is
        ignored.
        
        To use it in an ``except`` block::
        
            from tbvaccine import TBVaccine
            try:
                some_stuff()
            except:
                print(TBVaccine().format_exc())
        
        
        To make it the default way of printing tracebacks, use ``add_hook()``::
        
            import tbvaccine
            tbvaccine.add_hook()
        
            1 / 0
        
        Bam! Instant pretty tracebacks.
        
        
        Epilogue
        ========
        
        This library is still pretty new, please contribute patches if something doesn't
        work as intended, and also please tell your friends about it! Hopefully one day
        it will be implemented in the Python interpreters themselves.
        
        -- Stavros
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries :: Python Modules
