import sys
import os
import argparse
from ipypublish.convert.config_manager import iter_all_export_infos
[docs]class CustomParser(argparse.ArgumentParser):
[docs] def error(self, message):
sys.stderr.write('error: %s\n' % message)
self.print_help()
sys.exit(2)
[docs]def get_parser(**kwargs):
return CustomParser(
formatter_class=CustomFormatter,
**kwargs
)
[docs]def get_plugin_str(plugin_folder_paths):
"""return string listing all available export configurations """
outstrs = []
# outstrs.append('Available Export Configurations')
# outstrs.append('-------------------------------')
for item in sorted(iter_all_export_infos(plugin_folder_paths),
key=lambda i: (i["class"], i["key"])):
outstrs.append("- Key: {}".format(item["key"]))
outstrs.append(" Class: {}".format(item["class"]))
path = item["path"].split(os.path.sep)
if len(path) < 4:
outstrs.append(" Path: {}".format(item["path"]))
else:
outstrs.append(" Path: {}".format(
os.path.join("...", *path[-3:])))
outstrs.append(" About: {}".format(item["description"][0].strip()))
# TODO could wrap description (less than x characters)
outstrs.append(" ")
return "\n".join(outstrs)
[docs]def parse_options(sys_args, program):
assert program in ["nbpublish", "nbpresent"]
if program == "nbpresent":
parser = get_parser(
description=('load reveal.js slides as a web server,\n'
'converting from ipynb first '
'if path extension is `ipynb`'))
file_help = 'path to html or ipynb file'
default_key = 'slides_ipypublish_main'
else:
parser = get_parser(
description=('convert one or more Jupyter notebooks '
'to a publishable format'))
file_help = 'notebook file or directory'
default_key = 'latex_ipypublish_main'
parser.add_argument("filepath", type=str, nargs='?',
help=file_help,
metavar='filepath')
parser.add_argument("-f", "--outformat", type=str,
metavar='key|filepath',
help=('export format configuration to use, '
'can be a key name or path to the file'),
default=default_key)
export_group = parser.add_argument_group('export configurations')
export_group.add_argument("-ep", "--export-paths",
action='append', metavar='path', type=str,
help=("add additional folder paths, "
"containing export configurations"),
default=[os.path.join(os.getcwd(),
'ipypublish_plugins')])
export_group.add_argument("-le", "--list-exporters", action="store_true",
help=("list all known, "
"export configurations"))
# TODO filter list by part of key
nbmerge_group = parser.add_argument_group('nb merge')
nbmerge_group.add_argument("-i", "--ignore-prefix",
type=str, metavar='str', default='_',
help='ignore ipynb files with this prefix')
output_group = parser.add_argument_group('output')
output_group.add_argument("-o", "--outpath", type=str, metavar='str',
help='path to output converted files',
default=os.path.join(os.getcwd(), 'converted'))
# output_group.add_argument("-d","--dump-files", action="store_true",
# help='dump external files, '
# 'linked to in the document, into the outpath')
output_group.add_argument("-c", "--clear-files", action="store_true",
help=('clear any external files '
'that already exist in the outpath'))
if program == "nbpublish":
pdf_group = parser.add_argument_group('pdf export')
pdf_group.add_argument("-pdf", "--create-pdf", action="store_true",
help='convert to pdf (only if latex exporter)')
pdf_group.add_argument("-ptemp", "--pdf-in-temp", action="store_true",
help=('run pdf conversion in a temporary folder'
' and only copy back the .pdf file'))
pdf_group.add_argument("-pbug", "--pdf-debug", action="store_true",
help='run latexmk in interactive mode')
debug_group = parser.add_argument_group('debugging')
debug_group.add_argument("-log", "--log-level", type=str, default='info',
choices=['debug', 'info', 'warning', 'error'],
help='the logging level to output to screen/file')
debug_group.add_argument("-dr", "--dry-run", action="store_true",
help=("perform a 'dry run', "
"which will not output any files"))
args = parser.parse_args(sys_args)
options = vars(args)
filepath = options.pop('filepath')
list_plugins = options.pop("list_exporters")
if filepath is None and list_plugins:
parser.exit(message=get_plugin_str(options["export_paths"]))
elif filepath is None:
parser.error("no filepath specified")
return filepath, options