{"id":13578664,"url":"https://github.com/csurfer/pyheat","last_synced_at":"2025-05-15T18:06:39.201Z","repository":{"id":46987872,"uuid":"80954189","full_name":"csurfer/pyheat","owner":"csurfer","description":"pprofile + matplotlib = Python program profiled as an awesome heatmap!","archived":false,"fork":false,"pushed_at":"2023-07-04T11:25:43.000Z","size":134,"stargazers_count":839,"open_issues_count":8,"forks_count":46,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-31T22:14:27.030Z","etag":null,"topics":["heatmap","matplotlib","profiling","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csurfer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-02-04T22:56:02.000Z","updated_at":"2025-03-27T06:57:01.000Z","dependencies_parsed_at":"2024-01-14T15:21:46.899Z","dependency_job_id":"db325bf0-bf92-4ade-9709-97a73fbc699d","html_url":"https://github.com/csurfer/pyheat","commit_stats":{"total_commits":51,"total_committers":6,"mean_commits":8.5,"dds":0.4117647058823529,"last_synced_commit":"6517df5d6f169763f30afa2577d460aeecc6679d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csurfer%2Fpyheat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csurfer%2Fpyheat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csurfer%2Fpyheat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csurfer%2Fpyheat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csurfer","download_url":"https://codeload.github.com/csurfer/pyheat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247744332,"owners_count":20988783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["heatmap","matplotlib","profiling","python"],"created_at":"2024-08-01T15:01:32.687Z","updated_at":"2025-04-07T23:07:50.518Z","avatar_url":"https://github.com/csurfer.png","language":"Python","readme":"# pyheat\n\n[![pypiv](https://img.shields.io/pypi/v/py-heat.svg)](https://pypi.python.org/pypi/py-heat)\n[![pyv](https://img.shields.io/pypi/pyversions/py-heat.svg)](https://pypi.python.org/pypi/py-heat)\n[![Build Status](https://travis-ci.org/csurfer/pyheat.svg?branch=master)](https://travis-ci.org/csurfer/pyheat)\n[![Coverage Status](https://coveralls.io/repos/github/csurfer/pyheat/badge.svg?branch=master)](https://coveralls.io/github/csurfer/pyheat?branch=master)\n[![Licence](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/csurfer/pyheat/master/LICENSE)\n[![Thanks](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/csurfer)\n\nProfilers 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.\n\n\u003e A picture is worth a thousand words.\n\nSo, 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 !\n\n## Demo\n\n![Demo](http://i.imgur.com/qOeXUPR.png)\n\n## Scroll Demo\n\n![ScrollDemo](https://i.imgur.com/5IdH8AG.gif)\n\n## Features\n\n- Simple CLI interface.\n- No complicated setup.\n- Heatmap visualization to view hot zones in code.\n- Ability to export the heatmap as an image file.\n- Ability to scroll, to help view heatmap of large py files.\n\n## Setup\n\n### Using pip\n\n```bash\npip install py-heat\n```\n\n### Directly from the repository\n\n```bash\ngit clone https://github.com/csurfer/pyheat.git\npython pyheat/setup.py install\n```\n\n## Usage\n\n### As a command\n\n```bash\n# To view the heatmap.\npyheat \u003cpath_to_python_file\u003e\n# To output the heatmap as a file.\npyheat \u003cpath_to_python_file\u003e --out image_file.png\npyheat --help\n```\n\n### As a module\n\n```python\nfrom pyheat import PyHeat\nph = PyHeat(\u003cfile_path\u003e)\nph.create_heatmap()\n# To view the heatmap.\nph.show_heatmap()\n# To output the heatmap as a file.\nph.show_heatmap('image_file.png')\n```\n\n## Contributing\n\n### Bug Reports and Feature Requests\n\nPlease use [issue tracker](https://github.com/csurfer/pyheat/issues) for reporting bugs or feature requests.\n\n### Development\n\nPull requests are most welcome.\n\n### Buy the developer a cup of coffee!\n\nIf you found the utility helpful you can buy me a cup of coffee using\n\n[![Donate](https://www.paypalobjects.com/webstatic/en_US/i/btn/png/silver-pill-paypal-44px.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=3BSBW7D45C4YN\u0026lc=US\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted)\n","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=3BSBW7D45C4YN\u0026lc=US\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsurfer%2Fpyheat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsurfer%2Fpyheat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsurfer%2Fpyheat/lists"}