Metadata-Version: 1.1
Name: nose-cprof
Version: 0.2.1
Summary: A python nose plugin to profile using cProfile rather than the default Hotshot profiler.
Home-page: https://github.com/msherry/nose-cprof
Author: Marc Sherry
Author-email: msherry@gmail.com
License: UNKNOWN
Description-Content-Type: UNKNOWN
Description: nose-cprof
        ==========
        
        A plugin to use cProfile to profile
        `nosetests <https://nose.readthedocs.io/en/latest/>`__, rather than the
        built-in Hotshot profiler.
        
        Profiling tests can help track down sources of performance issues in
        code, especially if a synthetic test can be created to focus on the area
        of concern.
        
        The output generated by this plugin can easily be browsed using
        `pstats_viewer <https://github.com/msherry/pstats_viewer>`__, or any
        other pstats-compatible viewer.
        
        Getting started
        ---------------
        
        Prerequisites
        ~~~~~~~~~~~~~
        
        This is a plugin for `nose <https://nose.readthedocs.io/en/latest/>`__,
        so it’s useless without that installed.
        
        Installation
        ~~~~~~~~~~~~
        
        ``pip install nose-cprof``
        
        Usage
        ~~~~~
        
        This plugin adds some new options to ``nosetests``:
        
        ::
        
            --with-cprofile       Enable plugin cProfiler:  Use this plugin to run tests
                                  using the cProfile profiler.  [NOSE_WITH_CPROFILE]
            --cprofile-stats-file=FILE
                                  Output file name; default "stats.dat"
            --cprofile-stats-erase
                                  Erase previously-collected profiling statistics before
                                  run. Without this option, new profiling stats will be
                                  merged with the prior contents of the output file.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
