https://github.com/csurfer/pyheatmagic

IPython magic command to profile and view your python code as a heat map.
https://github.com/csurfer/pyheatmagic

heatmap ipython ipython-magic profiler

Last synced: 7 days ago
JSON representation

IPython magic command to profile and view your python code as a heat map.

• Host: GitHub
• URL: https://github.com/csurfer/pyheatmagic
• Owner: csurfer
• License: mit
• Created: 2017-08-18T20:35:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-14T18:30:54.000Z (7 months ago)
• Last Synced: 2025-02-06T16:14:18.197Z (14 days ago)
• Topics: heatmap, ipython, ipython-magic, profiler
• Language: Python
• Size: 14.6 KB
• Stars: 1,031
• Watchers: 12
• Forks: 23
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jupyter-resources - GitHub - 40% open · ⏱️ 10.09.2021): (Jupyter-magic拓展)
• starred-awesome - pyheatmagic - IPython magic command to profile and view your python code as a heat map. (Python)

README

        
# heat

[![pypiv](https://img.shields.io/pypi/v/py-heat-magic.svg)](https://pypi.python.org/pypi/py-heat-magic)

[![pyv](https://img.shields.io/pypi/pyversions/py-heat-magic.svg)](https://pypi.python.org/pypi/py-heat-magic)

[![Licence](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/csurfer/pyheatmagic/master/LICENSE)

[![Thanks](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/csurfer)

IPython magic command to profile and view your python code as a heat map using [py-heat](https://github.com/csurfer/pyheat).

## Demo

![Demo](http://i.imgur.com/IUtasPH.gif)

In case the demo was too fast, here is a [snapshot](http://i.imgur.com/isxRNV0.png) of the last step of the demo for deeper contemplation :)

## What is the magic command?

```python

%%heat

```

## Setup

### Using pip

```bash

pip install py-heat-magic

```

### Directly from the repository

```bash

git clone https://github.com/csurfer/pyheatmagic.git

python pyheatmagic/setup.py install

```

### Load Extension in IPython

```python

%load_ext heat

```

## Usage

```python

# To view the heatmap

%%heat

# To save the heatmap as a file

%%heat -o file.png

```

## Contributing

### Bug Reports and Feature Requests

Please use [issue tracker](https://github.com/csurfer/pyheatmagic/issues) 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](https://www.paypalobjects.com/webstatic/en_US/i/btn/png/silver-pill-paypal-44px.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=3BSBW7D45C4YN&lc=US&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted)