Config file and command line options¶
Jupyter nbclient can be run with a variety of command line arguments.
A list of available options can be found below in the options section.
Options¶
This list of options can be generated by running the following and hitting enter:
$ jupyter execute --help-all
- Application.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'The date format used by logging formatters for %(asctime)s
- Application.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'The Logging format template
- Application.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’`` Default:
30Set the log level by value or name.
- Application.show_configBool
Default:
FalseInstead of starting the Application, dump configuration to stdout
- Application.show_config_jsonBool
Default:
FalseInstead of starting the Application, dump configuration to stdout (as JSON)
- JupyterApp.answer_yesBool
Default:
FalseAnswer yes to any prompts.
- JupyterApp.config_fileUnicode
Default:
''Full path of a config file.
- JupyterApp.config_file_nameUnicode
Default:
''Specify a config file to load.
- JupyterApp.generate_configBool
Default:
FalseGenerate default config file.
- JupyterApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'The date format used by logging formatters for %(asctime)s
- JupyterApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'The Logging format template
- JupyterApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’`` Default:
30Set the log level by value or name.
- JupyterApp.show_configBool
Default:
FalseInstead of starting the Application, dump configuration to stdout
- JupyterApp.show_config_jsonBool
Default:
FalseInstead of starting the Application, dump configuration to stdout (as JSON)
- NbClientApp.allow_errorsBool
Default:
FalseWhen a cell raises an error the default behavior is that execution is stopped and a
nbclient.exceptions.CellExecutionErroris raised. If this flag is provided, errors are ignored and execution is continued until the end of the notebook.- NbClientApp.answer_yesBool
Default:
FalseAnswer yes to any prompts.
- NbClientApp.config_fileUnicode
Default:
''Full path of a config file.
- NbClientApp.config_file_nameUnicode
Default:
''Specify a config file to load.
- NbClientApp.generate_configBool
Default:
FalseGenerate default config file.
- NbClientApp.kernel_nameUnicode
Default:
''Name of kernel to use to execute the cells. If not set, use the kernel_spec embedded in the notebook.
- NbClientApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'The date format used by logging formatters for %(asctime)s
- NbClientApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'The Logging format template
- NbClientApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|’DEBUG’|’INFO’|’WARN’|’ERROR’|’CRITICAL’`` Default:
30Set the log level by value or name.
- NbClientApp.notebooksList
Default:
[]Path of notebooks to convert
- NbClientApp.show_configBool
Default:
FalseInstead of starting the Application, dump configuration to stdout
- NbClientApp.show_config_jsonBool
Default:
FalseInstead of starting the Application, dump configuration to stdout (as JSON)
- NbClientApp.skip_cells_with_tagUnicode
Default:
'skip-execution'Name of the cell tag to use to denote a cell that should be skipped.
- NbClientApp.startup_timeoutInt
Default:
60The time to wait (in seconds) for the kernel to start. If kernel startup takes longer, a RuntimeError is raised.
- NbClientApp.timeoutInt
Default:
NoneThe time to wait (in seconds) for output from executions. If a cell execution takes longer, a TimeoutError is raised.
-1will disable the timeout.