pprofile + matplotlib = Python program profiled as an awesome heatmap!
Project description
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 !
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
NOTE: Installation using pip would correspond to the latest release. Github repo on the other hand contains released features/bug fixes and the unreleased changes. Refer to CHANGELOG.rst for more information.
Using pip
pip install py-heatDirectly from the repository
git clone https://github.com/csurfer/pyheat.git
python pyheat/setup.py installUsage
As a command
# 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 --helpAs a module
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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
