Finished a rough draft of the exporters.

nbconvert/api/html_exporter.py

@@ -0,0 +1,47
+ """TODO: Docstring
+"""
+
+#-----------------------------------------------------------------------------
+# Copyright (c) 2013, the IPython Development Team.
+#
+# Distributed under the terms of the Modified BSD License.
+#
+# The full license is in the file COPYING.txt, distributed with this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+# local import
+import exporter
+import transformers.csshtmlheader
+
+#-----------------------------------------------------------------------------
+# Classes
+#-----------------------------------------------------------------------------
+class HtmlExporter(exporter.Exporter):
+
+    def __init__(self, preprocessors=None, jinja_filters=None, config=None, full_html=True, **kw):
+        
+        #Call base class constructor.
+        super(exporter.Exporter, self).__init__(preprocessors, jinja_filters, config, **kw)
+
+        #Set defaults
+        self.file_extension = "html"  
+        self.extract_figure_transformer.enabled = True
+        
+        #Load the correct template
+        if full_html:
+            self.template_file = "fullhtml"
+        else:
+            self.template_file = "basichtml"
+    
+    def _register_transformers(self):
+        
+        #Register the transformers of the base class.
+        super(exporter.Exporter, self)._register_transformers()
+        
+        #Register latex transformer
+        self.register_transformer(transformers.csshtmlheader.CSSHtmlHeaderTransformer)
+                    
  No newline at end of file

nbconvert/api/markdown_exporter.py

@@ -0,0 +1,32
+"""TODO: Docstring
+"""
+
+#-----------------------------------------------------------------------------
+# Copyright (c) 2013, the IPython Development Team.
+#
+# Distributed under the terms of the Modified BSD License.
+#
+# The full license is in the file COPYING.txt, distributed with this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+# local import
+import exporter
+
+#-----------------------------------------------------------------------------
+# Classes
+#-----------------------------------------------------------------------------
+class MarkdownExporter(exporter.Exporter):
+
+    def __init__(self, preprocessors=None, jinja_filters=None, config=None, **kw):
+        
+        #Call base class constructor.
+        super(exporter.Exporter, self).__init__(preprocessors, jinja_filters, config, **kw)
+
+        #Set defaults
+        self.file_extension = "md"  
+        self.extract_figure_transformer.enabled = True
+        self.template_file = "markdown"

nbconvert/api/python_exporter.py

@@ -0,0 +1,34
+"""TODO: Docstring
+"""
+
+#-----------------------------------------------------------------------------
+# Copyright (c) 2013, the IPython Development Team.
+#
+# Distributed under the terms of the Modified BSD License.
+#
+# The full license is in the file COPYING.txt, distributed with this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+# local import
+import exporter
+
+#-----------------------------------------------------------------------------
+# Classes
+#-----------------------------------------------------------------------------
+class PythonExporter(exporter.Exporter):
+
+    def __init__(self, preprocessors=None, jinja_filters=None, config=None, armor=False, **kw):
+        
+        #Call base class constructor.
+        super(exporter.Exporter, self).__init__(preprocessors, jinja_filters, config, **kw)
+
+        #Set defaults
+        self.file_extension = "py"  
+        if armor:
+            self.template_file = "python-armor"
+        else:
+            self.template_file = "python"

nbconvert/api/reveal_exporter.py

@@ -0,0 +1,41
+ """TODO: Docstring
+"""
+
+#-----------------------------------------------------------------------------
+# Copyright (c) 2013, the IPython Development Team.
+#
+# Distributed under the terms of the Modified BSD License.
+#
+# The full license is in the file COPYING.txt, distributed with this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+# local import
+import html_exporter
+import transformers.revealhelp
+
+#-----------------------------------------------------------------------------
+# Classes
+#-----------------------------------------------------------------------------
+class RevealExporter(html_exporter.HtmlExporter):
+
+    def __init__(self, preprocessors=None, jinja_filters=None, config=None, **kw):
+        
+        #Call base class constructor.
+        super(html_exporter.HtmlExporter, self).__init__(preprocessors, jinja_filters, config, **kw)
+
+        #Set defaults
+        self.file_extension = "reveal.html"
+        self.template_file = "reveal"
+
+    def _register_transformers(self):
+        
+        #Register the transformers of the base class.
+        super(html_exporter.HtmlExporter, self)._register_transformers()
+        
+        #Register reveal help transformer
+        self.register_transformer(transformers.revealhelp.RevealHelpTransformer)
+        
  No newline at end of file

nbconvert/api/rst_exporter.py

@@ -0,0 +1,51
+ """TODO: Docstring
+"""
+
+#-----------------------------------------------------------------------------
+# Copyright (c) 2013, the IPython Development Team.
+#
+# Distributed under the terms of the Modified BSD License.
+#
+# The full license is in the file COPYING.txt, distributed with this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+# local import
+import exporter
+
+#-----------------------------------------------------------------------------
+# Classes
+#-----------------------------------------------------------------------------
+class RstExporter(exporter.Exporter):
+
+    def __init__(self, preprocessors=None, jinja_filters=None, config=None, **kw):
+        
+        #Call base class constructor.
+        super(exporter.Exporter, self).__init__(preprocessors, jinja_filters, config, **kw)
+
+        #Set defaults
+        self.file_extension = "rst"
+        self.template_file = "rst"
+        self.extract_figure_transformer.enabled = True
+
+
+    def _register_filters(self):
+        
+        #Register the filters of the base class.
+        super(exporter.Exporter, self)._register_filters()
+
+        #Add latex filters to the Jinja2 environment
+        #self.register_filter('escape_tex', filters.latex.escape_tex)  
+
+    
+    def _register_transformers(self):
+        
+        #Register the transformers of the base class.
+        super(exporter.Exporter, self)._register_transformers()
+        
+        #Register latex transformer
+        #self.register_transformer(LatexTransformer)
+                    

nbconvert/api/sphinx_exporter.py

@@ -0,0 +1,48
+ """TODO: Docstring
+"""
+
+#-----------------------------------------------------------------------------
+# Copyright (c) 2013, the IPython Development Team.
+#
+# Distributed under the terms of the Modified BSD License.
+#
+# The full license is in the file COPYING.txt, distributed with this software.
+#-----------------------------------------------------------------------------
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+# local import
+import latex_exporter
+
+#-----------------------------------------------------------------------------
+# Classes
+#-----------------------------------------------------------------------------
+class SphinxExporter(latex_exporter.LatexExporter):
+
+    def __init__(self, preprocessors=None, jinja_filters=None, config=None, sphinx_type="howto", **kw):
+        
+        #Call base class constructor.
+        super(latex_exporter.LatexExporter, self).__init__(preprocessors, jinja_filters, config, **kw)
+
+        #Defaults
+        self.template_file = "latex_sphinx_" + sphinx_type
+
+    def _register_filters(self):
+        
+        #Register the filters of the base class.
+        super(latex_exporter.LatexExporter, self)._register_filters()
+
+        #Add latex filters to the Jinja2 environment
+        #self.register_filter('escape_tex', filters.latex.escape_tex)  
+
+    
+    def _register_transformers(self):
+        
+        #Register the transformers of the base class.
+        super(latex_exporter.LatexExporter, self)._register_transformers()
+        
+        #Register latex transformer
+        #self.register_transformer(LatexTransformer)
+                    

nbconvert/api/convert.py

@@ -14,10 +14,8 they are converted.
 #-----------------------------------------------------------------------------
 # Functions
 #-----------------------------------------------------------------------------
+
 def export_sphinx_report(nb, config=None):
     pass
-def export_sphinx_report(nb, fileName, config=None):
-    pass
 
 #TODO: Add basic export/import utility functions.
-__author__ = 'root'

nbconvert/api/exporter.py

@@ -23,6 +23,7 from __future__ import print_function, absolute_import
 # Stdlib imports
 import io
 import os
+import copy
 
 # IPython imports
 from IPython.config.configurable import Configurable
@@ -43,8 +44,6 import filters.pygments
 import filters.ansi
 
 import transformers.extractfigure
-import transformers.csshtmlheader
-import transformers.revealhelp
 import transformers.coalescestreams
 
 
@@ -104,6 +103,8 class Exporter(Configurable):
     #constructor for this class.
     preprocessors = [] 
 
+    # Public Constructor #####################################################
+    
     def __init__(self, preprocessors=None, jinja_filters=None, config=None, **kw):
         """ Init a new converter.
 
@@ -156,9 +157,12 class Exporter(Configurable):
                 else:
                     self.environment.filters[key] = user_filter
 
-        #Load the template file.
-        self.template = self.environment.get_template(self.template_file+self.ext)
 
+        #Set the default datatype priority.
+        self._set_datatype_priority(['svg', 'png', 'latex', 'jpg', 'jpeg','text'])
+        
+    
+    # Public methods #########################################
 
     def from_notebook_node(self, nb):
         """Export NotebookNode instance
@@ -171,6 +175,10 class Exporter(Configurable):
         """
 
         nb, resources = self._preprocess(nb)
+        
+        #Load the template file.
+        self.template = self.environment.get_template(self.template_file+self.ext)
+        
         return self.template.render(nb=nb, resources=resources), resources
 
 
@@ -212,13 +220,17 class Exporter(Configurable):
             self.environment.filters[name] = filter(config=self.config)
         else:
             self.environment.filters[name] = filter
+        return self.environment.filters[name]
 
+    # Protected and Private methods #########################################
 
     def _register_transformers(self):
         self.register_transformer(transformers.coalescestreams.coalesce_streams)
-        self.register_transformer(transformers.extractfigure.ExtractFigureTransformer)
-        self.register_transformer(transformers.revealhelp.RevealHelpTransformer)
-        self.register_transformer(transformers.csshtmlheader.CSSHtmlHeaderTransformer)
+        
+        #Remember the figure extraction transformer so it can be enabled and
+        #disabled easily later.
+        self.extract_figure_transformer = self.register_transformer(transformers.extractfigure.ExtractFigureTransformer)
+        self.extract_figure_transformer.enabled = False
         
         
     def _register_filters(self):
@@ -240,6 +252,11 class Exporter(Configurable):
         self.register_filter('wrap', filters.strings.wrap)
 
         
+    def _set_datatype_priority(self, priority):
+        self.extract_figure_transformer.display_data_priority=copy.copy(priority)
+        self.display_data_priority=copy.copy(priority)
+        
+        
     def _init_environment(self):
         self.environment = Environment(
             loader=FileSystemLoader([

nbconvert/api/latex_exporter.py

@@ -64,30 +64,17 class LatexExporter(exporter.Exporter):
     """
 
     def __init__(self, preprocessors=None, jinja_filters=None, config=None, **kw):
-        """ Init a new converter.
 
-        config: the Configurable config object to pass around.
-
-        preprocessors: dict of **available** key/value function to run on
-                       ipynb json data before conversion to extract/inline file.
-                       See `transformer.py` and `ConfigurableTransformers`
-
-                       set the order in which the transformers should apply
-                       with the `pre_transformer_order` trait of this class
-
-                       transformers registerd by this key will take precedence on
-                       default one.
-
-        jinja_filters: dict of supplementary jinja filter that should be made
-                       available in template. If those are of Configurable Class type,
-                       they will be instanciated with the config object as argument.
-
-                       user defined filter will overwrite the one available by default.
-        """
-
-        #Call the base class constructor
+        #Call base class constructor.
         super(exporter.Exporter, self).__init__(preprocessors, jinja_filters, config, **kw)
 
+        #Set defaults
+        self.file_extension = "tex"
+        self._set_datatype_priority(['latex', 'svg', 'png', 'jpg', 'jpeg' , 'text'])
+        self.extract_figure_transformer.enabled = True
+        self.extract_figure_transformer.extra_ext_map={'svg':'pdf'}
+        self.template_file = "latex_base"
+        
 
     def _init_environment(self):
         self.ext = LATEX_TEMPLATE_EXTENSION