Metadata-Version: 1.1
Name: py-heat
Version: 0.0.3
Summary: pprofile + matplotlib = Python program profiled as an awesome heatmap!
Home-page: https://github.com/csurfer/pyheat
Author: Vishwas B Sharma
Author-email: sharma.vishwas88@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Description: pyheat
        ======
        
        |pypiv| |pyv| |Licence| |Build Status| |Coverage Status| |Thanks|
        
        Profilers are extremely helpful tools. They help us dig deep into code,
        find and understand performance bottlenecks. But sometimes we just want
        to lay back, relax and still get a gist of the hot zones in our code.
        
            A picture is worth a thousand words.
        
        So, instead of presenting the data in tabular form, if presented as a
        heatmap visualization, it makes comprehending the time distribution in
        the given program much easier and quicker. That is exactly what is being
        done here !
        
        |Demo|
        
        Features
        --------
        
        * Simple CLI interface.
        
        * No complicated setup.
        
        * Heatmap visualization to view hot zones in code.
        
        * Ability to export the heatmap as an image file.
        
        Setup
        -----
        
        Using pip
        ~~~~~~~~~
        
        .. code:: bash
        
            pip install py-heat
        
        Directly from the repository
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: bash
        
            git clone https://github.com/csurfer/pyheat.git
            python pyheat/setup.py install
        
        Usage
        -----
        
        As a command
        ~~~~~~~~~~~~
        
        .. code:: bash
        
            # To view the heatmap.
            pyheat <path_to_python_file>
            # To output the heatmap as a file.
            pyheat <path_to_python_file> --out image_file.png
            pyheat --help
        
        As a module
        ~~~~~~~~~~~
        
        .. code:: python
        
            from pyheat import PyHeat
            ph = PyHeat(<file_path>)
            ph.create_heatmap()
            # To view the heatmap.
            ph.show_heatmap()
            # To output the heatmap as a file.
            ph.show_heatmap('image_file.png')
        
        Contributing
        ------------
        
        Bug Reports and Feature Requests
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Please use `issue tracker`_ for reporting bugs or feature requests.
        
        Development
        ~~~~~~~~~~~
        
        Pull requests are most welcome.
        
        
        Buy the developer a cup of coffee!
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        If you found the utility helpful you can buy me a cup of coffee using
        
        |Donate|
        
        .. |Donate| image:: https://www.paypalobjects.com/webstatic/en_US/i/btn/png/silver-pill-paypal-44px.png
           :target: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=3BSBW7D45C4YN&lc=US&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted
        
        .. |Thanks| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
           :target: https://saythanks.io/to/csurfer
        
        .. _issue tracker: https://github.com/csurfer/pyheat/issues
        
        .. |Build Status| image:: https://travis-ci.org/csurfer/pyheat.svg?branch=master
            :target: https://travis-ci.org/csurfer/pyheat
        
        .. |Licence| image:: https://img.shields.io/badge/license-MIT-blue.svg
           :target: https://raw.githubusercontent.com/csurfer/pyheat/master/LICENSE
        
        .. |Coverage Status| image:: https://coveralls.io/repos/github/csurfer/pyheat/badge.svg?branch=master
            :target: https://coveralls.io/github/csurfer/pyheat?branch=master
        
        .. |Demo| image:: http://i.imgur.com/qOeXUPR.png
        
        .. |pypiv| image:: https://img.shields.io/pypi/v/py-heat.svg
           :target: https://pypi.python.org/pypi/py-heat
        
        .. |pyv| image:: https://img.shields.io/pypi/pyversions/py-heat.svg
           :target: https://pypi.python.org/pypi/py-heat
        
Keywords: heatmap matplotlib profiling python
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
