py-heat-magic


Namepy-heat-magic JSON
Version 0.0.2 PyPI version JSON
download
home_pagehttps://github.com/csurfer/pyheatmagic
Summarypy-heat as IPython magic
upload_time2017-08-19 16:11:38
maintainer
docs_urlNone
authorVishwas B Sharma
requires_python
licenseMIT
keywords heatmap matplotlib profiling python ipython
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            heat
====

|pypiv| |pyv| |Licence| |Thanks|

IPython magic command to profile and view your python code as a heat map
using `py-heat`_.

Demo
----

|Demo|

In case the demo was too fast, here is a `snapshot`_ of the last step of the
demo for deeper contemplation :)

What is the magic command?
--------------------------

.. code:: python

    %%heat

Setup
-----

Using pip
~~~~~~~~~

.. code:: bash

    pip install py-heat-magic

Directly from the repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

    git clone https://github.com/csurfer/pyheatmagic.git
    python pyheatmagic/setup.py install

Load Extension in IPython
~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    %load_ext heat

Usage
-----

.. code:: 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`_ 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|



.. _py-heat: https://github.com/csurfer/pyheat

.. _snapshot: http://i.imgur.com/isxRNV0.png

.. _issue tracker: https://github.com/csurfer/pyheatmagic/issues

.. |Donate| image:: https://www.paypalobjects.com/webstatic/en_US/i/btn/png/silver-pill-paypal-34px.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

.. |Demo| image:: http://i.imgur.com/IUtasPH.gif

.. |Licence| image:: https://img.shields.io/badge/license-MIT-blue.svg
   :target: https://raw.githubusercontent.com/csurfer/pyheatmagic/master/LICENSE

.. |pypiv| image:: https://img.shields.io/pypi/v/py-heat-magic.svg
   :target: https://pypi.python.org/pypi/py-heat-magic

.. |pyv| image:: https://img.shields.io/pypi/pyversions/py-heat-magic.svg
   :target: https://pypi.python.org/pypi/py-heat-magic
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/csurfer/pyheatmagic",
    "name": "py-heat-magic",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "heatmap matplotlib profiling python IPython",
    "author": "Vishwas B Sharma",
    "author_email": "sharma.vishwas88@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/72/15/c5c56c91077ecb42a6415364cff41acb08a4f696f0261b3fc4025856d85c/py-heat-magic-0.0.2.tar.gz",
    "platform": "",
    "description": "heat\n====\n\n|pypiv| |pyv| |Licence| |Thanks|\n\nIPython magic command to profile and view your python code as a heat map\nusing `py-heat`_.\n\nDemo\n----\n\n|Demo|\n\nIn case the demo was too fast, here is a `snapshot`_ of the last step of the\ndemo for deeper contemplation :)\n\nWhat is the magic command?\n--------------------------\n\n.. code:: python\n\n    %%heat\n\nSetup\n-----\n\nUsing pip\n~~~~~~~~~\n\n.. code:: bash\n\n    pip install py-heat-magic\n\nDirectly from the repository\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: bash\n\n    git clone https://github.com/csurfer/pyheatmagic.git\n    python pyheatmagic/setup.py install\n\nLoad Extension in IPython\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n    %load_ext heat\n\nUsage\n-----\n\n.. code:: python\n\n    # To view the heatmap\n    %%heat\n\n    # To save the heatmap as a file\n    %%heat -o file.png\n\nContributing\n------------\n\nBug Reports and Feature Requests\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nPlease use `issue tracker`_ for reporting bugs or feature requests.\n\nDevelopment\n~~~~~~~~~~~\n\nPull requests are most welcome.\n\nBuy the developer a cup of coffee!\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf you found the utility helpful you can buy me a cup of coffee using\n\n|Donate|\n\n\n\n.. _py-heat: https://github.com/csurfer/pyheat\n\n.. _snapshot: http://i.imgur.com/isxRNV0.png\n\n.. _issue tracker: https://github.com/csurfer/pyheatmagic/issues\n\n.. |Donate| image:: https://www.paypalobjects.com/webstatic/en_US/i/btn/png/silver-pill-paypal-34px.png\n   :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\n\n.. |Thanks| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg\n   :target: https://saythanks.io/to/csurfer\n\n.. |Demo| image:: http://i.imgur.com/IUtasPH.gif\n\n.. |Licence| image:: https://img.shields.io/badge/license-MIT-blue.svg\n   :target: https://raw.githubusercontent.com/csurfer/pyheatmagic/master/LICENSE\n\n.. |pypiv| image:: https://img.shields.io/pypi/v/py-heat-magic.svg\n   :target: https://pypi.python.org/pypi/py-heat-magic\n\n.. |pyv| image:: https://img.shields.io/pypi/pyversions/py-heat-magic.svg\n   :target: https://pypi.python.org/pypi/py-heat-magic",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "py-heat as IPython magic",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/csurfer/pyheatmagic"
    },
    "split_keywords": [
        "heatmap",
        "matplotlib",
        "profiling",
        "python",
        "ipython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7215c5c56c91077ecb42a6415364cff41acb08a4f696f0261b3fc4025856d85c",
                "md5": "7364a9d4a1e5fba3732929987f9f1bfb",
                "sha256": "ec94abda6e84990724ff047c69a7b1765220ad65375179e88a8cebabfc7d3036"
            },
            "downloads": -1,
            "filename": "py-heat-magic-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7364a9d4a1e5fba3732929987f9f1bfb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3353,
            "upload_time": "2017-08-19T16:11:38",
            "upload_time_iso_8601": "2017-08-19T16:11:38.895471Z",
            "url": "https://files.pythonhosted.org/packages/72/15/c5c56c91077ecb42a6415364cff41acb08a4f696f0261b3fc4025856d85c/py-heat-magic-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2017-08-19 16:11:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "csurfer",
    "github_project": "pyheatmagic",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "py-heat-magic"
}
        
Elapsed time: 0.25973s