{ "info": { "author": "Kiko Correoso", "author_email": "kiko@example.noway", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Education", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Text Processing :: Markup :: HTML" ], "description": "tutormagic extension for the Jupyter notebook\n=============================================\n\n-------------------------------------------------------------------------\n\nRecommendation\n==============\n\nHave a look to `nbtutor `_, a more polished and better solution.\n\n-------------------------------------------------------------------------\n\nJupyter notebook magics to embed http://www.pythontutor.com within an IFrame in\nthe Jupyter notebook or to open a new tab in the browser using the code from a\nnotebook code cell (using the IPython kernel).\n\nInstall\n-------\n\n.. code:: python\n\n pip install tutormagic\n \nor\n\n.. code:: python\n\n conda install tutormagic\n\nor (for the development version)\n\n.. code:: python\n\n pip install git+https://github.com/kikocorreoso/tutormagic.git\n\nTested on Python 2.7.x, 3.4.x, 3.5.x and 3.6.x and IPython/Jupyter 3.x/4.x/5.x.\n\nUsage\n-----\n\nFirst, load the extension:\n\n.. code:: python\n\n %load_ext tutormagic\n\nOnce loaded, in a code cell in the notebook type the following:\n\n.. code:: python\n\n %%tutor --lang python3\n # some python code\n # ...\n\nto create an IFrame within the notebook with the http://www.pythontutor.com page\nwith the code included in the Jupyter code cell or:\n\n.. code:: python\n\n %%tutor --lang python3 --tab\n # some python code\n # ...\n\nto open http://www.pythontutor.com page in a new browser tab with the code \nincluded in the Jupyter code cell.\n\nOptions\n-------\n\n``--lang`` or ``-l``: it allows you to\nchoose one of the available languages supported by\n`pythontutor `__. It this option is set then\nit will consider the code in the cell as Python3 code.\n\n- ``%%tutor --lang python3`` or ``%%tutor -l python3`` or ``%%tutor``\n to show a pythontutor IFrame with **python3** code.\n- ``%%tutor --lang python2`` or ``%%tutor -l python2`` to show a\n pythontutor IFrame with **python2** code.\n- ``%%tutor --lang java`` or ``%%tutor -l java`` to show a pythontutor\n IFrame with **java** code.\n- ``%%tutor --lang javascript`` or ``%%tutor -l javascript`` to show a\n pythontutor IFrame with **javascript** code.\n- ``%%tutor --lang typescript`` or ``%%tutor -l typescript`` to show a \n pythontutor IFrame with **typescript** code.\n- ``%%tutor --lang ruby`` or ``%%tutor -l ruby`` to show a \n pythontutor IFrame with **ruby** code.\n- ``%%tutor --lang c`` or ``%%tutor -l c`` to show a \n pythontutor IFrame with **c** code.\n- ``%%tutor --lang c++`` or ``%%tutor -l c++`` to show a \n pythontutor IFrame with **c++** code.\n \n .. image:: https://raw.githubusercontent.com/kikocorreoso/tutormagic/master/imgs/normal.png\n :width: 500 px\n\n``--height`` or ``-h``: it changes the height of the output area display in pixels. It is used to define the height of the IFrame used to embed http://pythontutor.com within the notebook. If the `--tab` option is used \nthis option will be ignored.\n\n .. image:: https://raw.githubusercontent.com/kikocorreoso/tutormagic/master/imgs/height.png\n :width: 500 px\n\n``--tab`` or ``-t``: it will open http://pythontutor.com in a new tab \ninstead of within an IFrame within the notebook.\n\n``--secure`` or ``-s``: it will use HTTPS to open PythonTutor.com. This is useful when being used in a notebook that uses SSL.\n\n``--link`` or ``-k``: it will display a link to PythonTutor, not via an iFrame.\n\n .. image:: https://raw.githubusercontent.com/kikocorreoso/tutormagic/master/imgs/link1.png\n :width: 500 px\n\n``--run`` or ``-r``: Use this option if you also want to run the code in the cell in the notebook.\n\n .. image:: https://raw.githubusercontent.com/kikocorreoso/tutormagic/master/imgs/run1.png\n :width: 500 px\n\nYou can customize how PythonTutor is rendered via the options available below in the URL params. The following options are available:\n\n- Use the ``--cumulative`` option to tell PythonTutor to the cumulative to True\n\n .. image:: https://raw.githubusercontent.com/kikocorreoso/tutormagic/master/imgs/cumulative1.png\n :width: 500 px\n\n- Use the ``--heapPrimitives`` option to tell PythonTutor to render objects on the heap\n \n .. image:: https://raw.githubusercontent.com/kikocorreoso/tutormagic/master/imgs/test_heap1.png\n :width: 500 px\n\n- Use the ``--textReferences`` option to tell PythonTutor to use text labels for references\n- Use the ``--curInstr`` followed by a number to start the visualisation at the defined step\n \n .. image:: https://raw.githubusercontent.com/kikocorreoso/tutormagic/master/imgs/current1.png\n :width: 500 px\n\n- Use the ``--verticalStack`` to set visualization to stack atop one another.\n \n .. image:: https://raw.githubusercontent.com/kikocorreoso/tutormagic/master/imgs/vertical1.png\n :width: 500 px\n\nExamples\n--------\n\n`Example notebook included in the repository `__.\n\n`Example (in spanish)\nnotebook `__.\n\nName of the extension\n---------------------\n\nThe name of the extension was suggested by Doug S. Blank \n(`@dsblank `__).\n\nChangelog\n---------\n\nVersion 0.2.1\n~~~~~~~~~~~~~\n\n- Added options ``--secure``, ``--link``, ``--cumulative``, ``--heapPrimitives`` and ``--textReferences`` (thanks to James Quacinella (`@jquacinella `__)).\n- Added options ``--run``, ``--curInstr`` and ``--verticalStack``.\n\nVersion 0.2.0\n~~~~~~~~~~~~~\n\n- Added new ``--tab`` option (thanks to Holger Karl (`@hkarl `__)).\n- Added new ``--height`` option (thanks to Tom Simonart(`@tomsimonart `__)).\n- Added new languages available on http://pythontutor.com (Typescript, Ruby, C and C++).\n\nVersion 0.1.0\n~~~~~~~~~~~~~\n\n- Initial version\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kikocorreoso/tutormagic", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "tutormagic", "package_url": "https://pypi.org/project/tutormagic/", "platform": "", "project_url": "https://pypi.org/project/tutormagic/", "project_urls": { "Homepage": "https://github.com/kikocorreoso/tutormagic" }, "release_url": "https://pypi.org/project/tutormagic/0.3.0/", "requires_dist": [ "notebook>=3.0" ], "requires_python": ">=2.7", "summary": "==========", "version": "0.3.0" }, "last_serial": 3165168, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "34d34ec79e04ea3f1f5d706752319528", "sha256": "8b699fa57765fa682cacad313d9853154b008994ee05cef9ffb9331d633574ae" }, "downloads": -1, "filename": "tutormagic-0.1.0.tar.gz", "has_sig": false, "md5_digest": "34d34ec79e04ea3f1f5d706752319528", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3128, "upload_time": "2015-03-25T18:16:40", "url": "https://files.pythonhosted.org/packages/4c/23/1254416d4339c2310ceed229881cc3801deaf58f3e16e136431c383e6605/tutormagic-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "19b061e6aacd843a0491bcaec2c5263c", "sha256": "fb662695ddff4d552690529d3af6fba169a723bf4c506fcb526a201617c0e596" }, "downloads": -1, "filename": "tutormagic-0.2.0.zip", "has_sig": false, "md5_digest": "19b061e6aacd843a0491bcaec2c5263c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7787, "upload_time": "2016-07-22T09:47:21", "url": "https://files.pythonhosted.org/packages/ca/0c/a925f0e7f439b3ef62a3f76dbf2b3d005f26eb2803737db8b56a67fe8c60/tutormagic-0.2.0.zip" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "0228f14f1a01bf542fba1309a68871bf", "sha256": "60d802e7d85fd4a15129d165869d317f01b5fccb404dbe58bd2cc540387835b5" }, "downloads": -1, "filename": "tutormagic-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0228f14f1a01bf542fba1309a68871bf", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7", "size": 11362, "upload_time": "2017-09-11T12:34:51", "url": "https://files.pythonhosted.org/packages/26/4c/170e56dce3ecbf0608f37b3b99100bd2666cac181da14bc685516e958435/tutormagic-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4824641e23620df7f3079c52799210ef", "sha256": "328b2b04d68f26be5c90ab92104bfab12c07ab0e6b5aaae00de676d42af243d9" }, "downloads": -1, "filename": "tutormagic-0.3.0.tar.gz", "has_sig": false, "md5_digest": "4824641e23620df7f3079c52799210ef", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 677460, "upload_time": "2017-09-11T12:34:55", "url": "https://files.pythonhosted.org/packages/ef/2b/d9734af4cce6fa7d44cd2c0b5abd78e0bfd613b97b4836918b9e5cb09036/tutormagic-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0228f14f1a01bf542fba1309a68871bf", "sha256": "60d802e7d85fd4a15129d165869d317f01b5fccb404dbe58bd2cc540387835b5" }, "downloads": -1, "filename": "tutormagic-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0228f14f1a01bf542fba1309a68871bf", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7", "size": 11362, "upload_time": "2017-09-11T12:34:51", "url": "https://files.pythonhosted.org/packages/26/4c/170e56dce3ecbf0608f37b3b99100bd2666cac181da14bc685516e958435/tutormagic-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4824641e23620df7f3079c52799210ef", "sha256": "328b2b04d68f26be5c90ab92104bfab12c07ab0e6b5aaae00de676d42af243d9" }, "downloads": -1, "filename": "tutormagic-0.3.0.tar.gz", "has_sig": false, "md5_digest": "4824641e23620df7f3079c52799210ef", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 677460, "upload_time": "2017-09-11T12:34:55", "url": "https://files.pythonhosted.org/packages/ef/2b/d9734af4cce6fa7d44cd2c0b5abd78e0bfd613b97b4836918b9e5cb09036/tutormagic-0.3.0.tar.gz" } ] }