Metadata-Version: 2.0
Name: tex2ipy
Version: 0.2
Summary: Convert beamer presentations to IPython notebooks
Home-page: https://github.com/prabhuramachandran/tex2ipy
Author: Prabhu Ramachandran
Author-email: prabhu@aero.iitb.ac.in
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: IPython
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Dist: TexSoup
Requires-Dist: nbformat

Tex2IPython Notebook
====================

|Build Status| |codecov|

This package makes it easy to convert a LaTeX file (currently) typically
using the beamer package into an IPython notebook with
`RISE <https://github.com/damianavila/RISE>`__.

To use the package, simply run:

::

    $ tex2ipy talk.tex talk.ipynb

This does not attempt to completely cover all TeX macros. Bulk of the
basics should work hopefully covering 90% of the basic macros.

There is a simple example presentation LaTeX file in the
`examples <https://github.com/prabhuramachandran/tex2ipy/tree/master/examples>`__
directory along with the converted IPython notebook.

Customization
-------------

If you wish to support more macros or your own, you can subclass
``Tex2Cells`` and add any handlers for your own macros. Let us say you
add additional methods to your subclass and in a file called
``customize.py`` you can use this file as follows:

::

    $ tex2ipy -c customize.py talk.tex talk.ipynb

This will use your customizations for the conversion.

Known issues
------------

``tex2ipy`` uses the very convenient
`TexSoup <https://github.com/alvinwan/TexSoup>`__ package to parse
LaTeX. This package has a few issues with parsing inline math
expressions embedded inside itemize/enumerate lists. This can cause some
issues when converting files.

.. |Build Status| image:: https://travis-ci.org/prabhuramachandran/tex2ipy.svg?branch=master
   :target: https://travis-ci.org/prabhuramachandran/tex2ipy
.. |codecov| image:: https://codecov.io/gh/prabhuramachandran/tex2ipy/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/prabhuramachandran/tex2ipy


