Metadata-Version: 2.0
Name: ipyaml
Version: 0.1
Summary: Convert IPython notebooks to YAML and vice-versa
Home-page: https://github.com/prabhuramachandran/ipyaml
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 :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Dist: nbformat
Requires-Dist: pyyaml

IPython notebooks to YAML
=========================

|Build Status| |codecov|

This simple project allows one to convert IPython notebooks to easily
editable YAML files. This is very similar to the
`notedown <http://github.com/aaren/notedown>`__ and
`ipymd <http://github.com/rossant/ipymd>`__ packages but supports all
IPython outputs as well.

The advantage of using this package is that you get complete
compatibility with IPython notebooks and the ability to edit the files
in any text editor.

The format is YAML so it is not as pretty as Markdown but is a
reasonable compromise.

Installation
------------

Install the package as follows:

::

    $ pip install ipyaml

Usage
-----

Run the command ``ipyaml`` to convert between the two formats:

::

    $ ipyaml notebook.ipynb notebook.ipyml  # or notebook.ipyaml

    $ ipyaml notebook.ipyml notebook.ipynb

If you do not want to store the cell outputs in your YAML files you may
also run the ``ipyaml`` script as follows:

::

    $ ipyaml --no-output notebook.ipynb notebook.ipyml

This will loose all outputs. By default, all the outputs are also
written to the output. Take a look at the output without output to see
that it is very easy to manually remove the outputs if they are not
desired.

If you want jupyter to automatically load and save the ``.ipyml`` files.
Add the following to your ``jupyter_notebook_config.py``:

::

    c.NotebookApp.contents_manager_class = 'ipyaml.api.YAMLContentsManager'

The ``jupyter_notebook_config.py`` can be found by running:

::

    $ jupyter --config-dir

If you don't see a ``jupyter_notebook_config.py`` you can do this:

::

    $ jupyter notebook --generate-config

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


