Metadata-Version: 1.1
Name: yep
Version: 0.3
Summary: A module for profiling compiled extensions
Home-page: http://pypi.python.org/pypi/yep
Author: Fabian Pedregosa
Author-email: fabian.pedregosa@inria.fr
License: UNKNOWN
Description: ===============================
        The Python Extension Profiler
        ===============================
        
        extension_profiler is a tool to profile compiled code (C/C++/Fortran) from the Python
        interpreter. It uses the google-perftools CPU profiler and depends on
        pprof (google-pprof on Debian) for visualization.
        
        
        Install
        -------
        
        This package depends on google-perftools (package google-perftools in
        Debian). Once you have fulfilled these depencies you can install it
        with easy_install::
        
            $ easy_install -U yep
        
        or download the package, uncompress and execute the standard command::
        
            $ python setup.py install
        
        However, since the package one-file distribution, you can also just
        put yep.py somewhere in your $PYTHONPATH.
        
        
        Usage
        -----
        
        There are various ways to use the profiler. The simplest is add this
        module as argument to the Python interpreter when running your
        script and add flag -v to visualize the result::
        
            $ python -m yep -v -- my_script.py [arg] ... ...
        
        This will create a file my_script.py.prof that can be analyzed with
        pprof. Execute ``python -m yep`` to get the full list of options.
        
        It is also possible to manually start/stop the profiler from inside
        Python code::
        
            >>> import yep
            >>> yep.start('file_name.prof')
            >>> # do your computations
            >>> yep.stop()
        
        This will create a file_name.prof to be analized with pperf.
        
        
        Development
        -----------
        
        Git repository can be found here::
        
            https://github.com/fabianp/yep
        
        
        Bugs
        ----
        
        Visualize the result with -v will only work on UNIX. An option --prof=
        would also be nice.
        
        
        Misc
        ----
        
        Author: Fabian Pedregosa <fabian.pedregosa@inria.fr>
        
        
        License
        -------
        
        Simplified BSD License, (C) 2011 Fabian Pedregosa.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
