##// END OF EJS Templates
mention local config file in examples
MinRK -
Show More
@@ -1,223 +1,229 b''
1 #!/usr/bin/env python
1 #!/usr/bin/env python
2 """NBConvert is a utility for conversion of .ipynb files.
2 """NBConvert is a utility for conversion of .ipynb files.
3
3
4 Command-line interface for the NbConvert conversion utility.
4 Command-line interface for the NbConvert conversion utility.
5 """
5 """
6 #-----------------------------------------------------------------------------
6 #-----------------------------------------------------------------------------
7 #Copyright (c) 2013, the IPython Development Team.
7 #Copyright (c) 2013, the IPython Development Team.
8 #
8 #
9 #Distributed under the terms of the Modified BSD License.
9 #Distributed under the terms of the Modified BSD License.
10 #
10 #
11 #The full license is in the file COPYING.txt, distributed with this software.
11 #The full license is in the file COPYING.txt, distributed with this software.
12 #-----------------------------------------------------------------------------
12 #-----------------------------------------------------------------------------
13
13
14 #-----------------------------------------------------------------------------
14 #-----------------------------------------------------------------------------
15 #Imports
15 #Imports
16 #-----------------------------------------------------------------------------
16 #-----------------------------------------------------------------------------
17
17
18 #Stdlib imports
18 #Stdlib imports
19 from __future__ import print_function
19 from __future__ import print_function
20 import sys
20 import sys
21 import os
21 import os
22 import glob
22 import glob
23
23
24 #From IPython
24 #From IPython
25 from IPython.core.application import BaseIPythonApplication, base_aliases, base_flags
25 from IPython.core.application import BaseIPythonApplication, base_aliases, base_flags
26 from IPython.config import catch_config_error, Configurable
26 from IPython.config import catch_config_error, Configurable
27 from IPython.utils.traitlets import (
27 from IPython.utils.traitlets import (
28 Unicode, List, Instance, DottedObjectName, Type, CaselessStrEnum,
28 Unicode, List, Instance, DottedObjectName, Type, CaselessStrEnum,
29 )
29 )
30 from IPython.utils.importstring import import_item
30 from IPython.utils.importstring import import_item
31
31
32 from .exporters.export import export_by_name, get_export_names, ExporterNameError
32 from .exporters.export import export_by_name, get_export_names, ExporterNameError
33 from IPython.nbconvert import exporters, transformers, writers
33 from IPython.nbconvert import exporters, transformers, writers
34 from .utils.base import NbConvertBase
34 from .utils.base import NbConvertBase
35
35
36 #-----------------------------------------------------------------------------
36 #-----------------------------------------------------------------------------
37 #Classes and functions
37 #Classes and functions
38 #-----------------------------------------------------------------------------
38 #-----------------------------------------------------------------------------
39
39
40 nbconvert_aliases = {}
40 nbconvert_aliases = {}
41 nbconvert_aliases.update(base_aliases)
41 nbconvert_aliases.update(base_aliases)
42 nbconvert_aliases.update({
42 nbconvert_aliases.update({
43 'format' : 'NbConvertApp.export_format',
43 'format' : 'NbConvertApp.export_format',
44 'notebooks' : 'NbConvertApp.notebooks',
44 'notebooks' : 'NbConvertApp.notebooks',
45 'writer' : 'NbConvertApp.writer_class',
45 'writer' : 'NbConvertApp.writer_class',
46 })
46 })
47
47
48 nbconvert_flags = {}
48 nbconvert_flags = {}
49 nbconvert_flags.update(base_flags)
49 nbconvert_flags.update(base_flags)
50 nbconvert_flags.update({
50 nbconvert_flags.update({
51 'stdout' : (
51 'stdout' : (
52 {'NbConvertApp' : {'writer_class' : "StdoutWriter"}},
52 {'NbConvertApp' : {'writer_class' : "StdoutWriter"}},
53 "Write notebook output to stdout instead of files."
53 "Write notebook output to stdout instead of files."
54 )
54 )
55 })
55 })
56
56
57
57
58 class NbConvertApp(BaseIPythonApplication):
58 class NbConvertApp(BaseIPythonApplication):
59 """Application used to convert to and from notebook file type (*.ipynb)"""
59 """Application used to convert to and from notebook file type (*.ipynb)"""
60
60
61 name = 'ipython-nbconvert'
61 name = 'ipython-nbconvert'
62 aliases = nbconvert_aliases
62 aliases = nbconvert_aliases
63 flags = nbconvert_flags
63 flags = nbconvert_flags
64
64
65 def _classes_default(self):
65 def _classes_default(self):
66 classes = [NbConvertBase]
66 classes = [NbConvertBase]
67 for pkg in (exporters, transformers, writers):
67 for pkg in (exporters, transformers, writers):
68 for name in dir(pkg):
68 for name in dir(pkg):
69 cls = getattr(pkg, name)
69 cls = getattr(pkg, name)
70 if isinstance(cls, type) and issubclass(cls, Configurable):
70 if isinstance(cls, type) and issubclass(cls, Configurable):
71 classes.append(cls)
71 classes.append(cls)
72 return classes
72 return classes
73
73
74 description = Unicode(
74 description = Unicode(
75 u"""This application is used to convert notebook files (*.ipynb)
75 u"""This application is used to convert notebook files (*.ipynb)
76 to various other formats.""")
76 to various other formats.""")
77
77
78 examples = Unicode(u"""
78 examples = Unicode(u"""
79 The simplest way to use nbconvert is
79 The simplest way to use nbconvert is
80
80
81 > ipython nbconvert mynotebook.ipynb
81 > ipython nbconvert mynotebook.ipynb
82
82
83 which will convert mynotebook.ipynb to the default format (probably HTML).
83 which will convert mynotebook.ipynb to the default format (probably HTML).
84
84
85 You can specify the export format with `--format`.
85 You can specify the export format with `--format`.
86 Options include {0}
86 Options include {0}
87
87
88 > ipython nbconvert --format latex mynotebook.ipnynb
88 > ipython nbconvert --format latex mynotebook.ipnynb
89
89
90 You can also pipe the output to stdout, rather than a file
90 You can also pipe the output to stdout, rather than a file
91
91
92 > ipython nbconvert mynotebook.ipynb --stdout
92 > ipython nbconvert mynotebook.ipynb --stdout
93
93
94 Multiple notebooks can be given at the command line in a couple of
94 Multiple notebooks can be given at the command line in a couple of
95 different ways:
95 different ways:
96
96
97 > ipython nbconvert notebook*.ipynb
97 > ipython nbconvert notebook*.ipynb
98 > ipython nbconvert notebook1.ipynb notebook2.ipynb
98 > ipython nbconvert notebook1.ipynb notebook2.ipynb
99
100 or you can specify the notebooks list in a config file, containing::
101
102 c.NbConvertApp.notebooks = ["my_notebook.ipynb"]
103
104 > ipython nbconvert --config mycfg.py
99 """.format(get_export_names()))
105 """.format(get_export_names()))
100 #Writer specific variables
106 #Writer specific variables
101 writer = Instance('IPython.nbconvert.writers.base.WriterBase',
107 writer = Instance('IPython.nbconvert.writers.base.WriterBase',
102 help="""Instance of the writer class used to write the
108 help="""Instance of the writer class used to write the
103 results of the conversion.""")
109 results of the conversion.""")
104 writer_class = DottedObjectName('FilesWriter', config=True,
110 writer_class = DottedObjectName('FilesWriter', config=True,
105 help="""Writer class used to write the
111 help="""Writer class used to write the
106 results of the conversion""")
112 results of the conversion""")
107 writer_aliases = {'FilesWriter': 'IPython.nbconvert.writers.files.FilesWriter',
113 writer_aliases = {'FilesWriter': 'IPython.nbconvert.writers.files.FilesWriter',
108 'DebugWriter': 'IPython.nbconvert.writers.debug.DebugWriter',
114 'DebugWriter': 'IPython.nbconvert.writers.debug.DebugWriter',
109 'StdoutWriter': 'IPython.nbconvert.writers.stdout.StdoutWriter'}
115 'StdoutWriter': 'IPython.nbconvert.writers.stdout.StdoutWriter'}
110 writer_factory = Type()
116 writer_factory = Type()
111
117
112 def _writer_class_changed(self, name, old, new):
118 def _writer_class_changed(self, name, old, new):
113 if new in self.writer_aliases:
119 if new in self.writer_aliases:
114 new = self.writer_aliases[new]
120 new = self.writer_aliases[new]
115 self.writer_factory = import_item(new)
121 self.writer_factory = import_item(new)
116
122
117
123
118 #Other configurable variables
124 #Other configurable variables
119 export_format = CaselessStrEnum(get_export_names(),
125 export_format = CaselessStrEnum(get_export_names(),
120 default_value="full_html",
126 default_value="full_html",
121 config=True,
127 config=True,
122 help="""The export format to be used."""
128 help="""The export format to be used."""
123 )
129 )
124
130
125 notebooks = List([], config=True, help="""List of notebooks to convert.
131 notebooks = List([], config=True, help="""List of notebooks to convert.
126 Wildcards are supported.
132 Wildcards are supported.
127 Filenames passed positionally will be added to the list.
133 Filenames passed positionally will be added to the list.
128 """)
134 """)
129
135
130 @catch_config_error
136 @catch_config_error
131 def initialize(self, argv=None):
137 def initialize(self, argv=None):
132 super(NbConvertApp, self).initialize(argv)
138 super(NbConvertApp, self).initialize(argv)
133 self.init_notebooks()
139 self.init_notebooks()
134 self.init_writer()
140 self.init_writer()
135
141
136 def init_notebooks(self):
142 def init_notebooks(self):
137 """Construct the list of notebooks.
143 """Construct the list of notebooks.
138 If notebooks are passed on the command-line,
144 If notebooks are passed on the command-line,
139 they override notebooks specified in config files.
145 they override notebooks specified in config files.
140 Glob each notebook to replace notebook patterns with filenames.
146 Glob each notebook to replace notebook patterns with filenames.
141 """
147 """
142
148
143 # Specifying notebooks on the command-line overrides (rather than adds)
149 # Specifying notebooks on the command-line overrides (rather than adds)
144 # the notebook list
150 # the notebook list
145 if self.extra_args:
151 if self.extra_args:
146 patterns = self.extra_args
152 patterns = self.extra_args
147 else:
153 else:
148 patterns = self.notebooks
154 patterns = self.notebooks
149
155
150 #Use glob to replace all the notebook patterns with filenames.
156 #Use glob to replace all the notebook patterns with filenames.
151 filenames = []
157 filenames = []
152 for pattern in patterns:
158 for pattern in patterns:
153 for filename in glob.glob(pattern):
159 for filename in glob.glob(pattern):
154 if not filename in filenames:
160 if not filename in filenames:
155 filenames.append(filename)
161 filenames.append(filename)
156 self.notebooks = filenames
162 self.notebooks = filenames
157
163
158 def init_writer(self):
164 def init_writer(self):
159 """
165 """
160 Initialize the writer (which is stateless)
166 Initialize the writer (which is stateless)
161 """
167 """
162 self._writer_class_changed(None, self.writer_class, self.writer_class)
168 self._writer_class_changed(None, self.writer_class, self.writer_class)
163 self.writer = self.writer_factory(parent=self)
169 self.writer = self.writer_factory(parent=self)
164
170
165 def start(self):
171 def start(self):
166 """
172 """
167 Ran after initialization completed
173 Ran after initialization completed
168 """
174 """
169 super(NbConvertApp, self).start()
175 super(NbConvertApp, self).start()
170 self.convert_notebooks()
176 self.convert_notebooks()
171
177
172 def convert_notebooks(self):
178 def convert_notebooks(self):
173 """
179 """
174 Convert the notebooks in the self.notebook traitlet
180 Convert the notebooks in the self.notebook traitlet
175 """
181 """
176 #Export each notebook
182 #Export each notebook
177 conversion_success = 0
183 conversion_success = 0
178 for notebook_filename in self.notebooks:
184 for notebook_filename in self.notebooks:
179
185
180 #Get a unique key for the notebook and set it in the resources object.
186 #Get a unique key for the notebook and set it in the resources object.
181 basename = os.path.basename(notebook_filename)
187 basename = os.path.basename(notebook_filename)
182 notebook_name = basename[:basename.rfind('.')]
188 notebook_name = basename[:basename.rfind('.')]
183 resources = {}
189 resources = {}
184 resources['unique_key'] = notebook_name
190 resources['unique_key'] = notebook_name
185
191
186 #Try to export
192 #Try to export
187 try:
193 try:
188 output, resources = export_by_name(self.export_format,
194 output, resources = export_by_name(self.export_format,
189 notebook_filename,
195 notebook_filename,
190 resources=resources,
196 resources=resources,
191 config=self.config)
197 config=self.config)
192 except ExporterNameError as e:
198 except ExporterNameError as e:
193 print("Error: '%s' exporter not found." % self.export_format,
199 print("Error: '%s' exporter not found." % self.export_format,
194 file=sys.stderr)
200 file=sys.stderr)
195 print("Known exporters are:",
201 print("Known exporters are:",
196 "\n\t" + "\n\t".join(get_export_names()),
202 "\n\t" + "\n\t".join(get_export_names()),
197 file=sys.stderr)
203 file=sys.stderr)
198 sys.exit(-1)
204 sys.exit(-1)
199 #except Exception as e:
205 #except Exception as e:
200 #print("Error: could not export '%s'" % notebook_filename, file=sys.stderr)
206 #print("Error: could not export '%s'" % notebook_filename, file=sys.stderr)
201 #print(e, file=sys.stderr)
207 #print(e, file=sys.stderr)
202 else:
208 else:
203 self.writer.write(output, resources, notebook_name=notebook_name)
209 self.writer.write(output, resources, notebook_name=notebook_name)
204 conversion_success += 1
210 conversion_success += 1
205
211
206 #If nothing was converted successfully, help the user.
212 #If nothing was converted successfully, help the user.
207 if conversion_success == 0:
213 if conversion_success == 0:
208
214
209 #No notebooks were specified, show help.
215 #No notebooks were specified, show help.
210 if len(self.notebooks) == 0:
216 if len(self.notebooks) == 0:
211 self.print_help()
217 self.print_help()
212
218
213 #Notebooks were specified, but not converted successfully. Show how
219 #Notebooks were specified, but not converted successfully. Show how
214 #to access help.
220 #to access help.
215 else:
221 else:
216 print('For help, use "ipython nbconvert --help"')
222 print('For help, use "ipython nbconvert --help"')
217
223
218
224
219 #-----------------------------------------------------------------------------
225 #-----------------------------------------------------------------------------
220 # Main entry point
226 # Main entry point
221 #-----------------------------------------------------------------------------
227 #-----------------------------------------------------------------------------
222
228
223 launch_new_instance = NbConvertApp.launch_instance
229 launch_new_instance = NbConvertApp.launch_instance
General Comments 0
You need to be logged in to leave comments. Login now