Configuration options¶
See also
- The nbgrader_config.py file
Details on how to setup the
nbgrader_config.py
file.
These options can be set in nbgrader_config.py
, or at the command
line when you start it.
- 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:
30
Set the log level by value or name.
- Application.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- Application.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- Application.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- JupyterApp.answer_yesBool
Default:
False
Answer 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:
False
Generate 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:
30
Set the log level by value or name.
- JupyterApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- JupyterApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- JupyterApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- NbGrader.answer_yesBool
Default:
False
Answer yes to any prompts.
- NbGrader.config_fileUnicode
Default:
''
Full path of a config file.
- NbGrader.config_file_nameUnicode
Default:
''
Specify a config file to load.
- NbGrader.generate_configBool
Default:
False
Generate default config file.
- NbGrader.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- NbGrader.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- NbGrader.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- NbGrader.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- NbGrader.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- NbGrader.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- NbGrader.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- NbGraderApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- NbGraderApp.config_fileUnicode
Default:
''
Full path of a config file.
- NbGraderApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- NbGraderApp.generate_configBool
Default:
False
Generate default config file.
- NbGraderApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- NbGraderApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- NbGraderApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- NbGraderApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- NbGraderApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- NbGraderApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- NbGraderApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ExchangeFactory.collectType
Default:
'nbgrader.exchange.default.collect.ExchangeCollect'
A plugin for collecting assignments.
- ExchangeFactory.exchangeType
Default:
'nbgrader.exchange.default.exchange.Exchange'
A plugin for exchange.
- ExchangeFactory.fetch_assignmentType
Default:
'nbgrader.exchange.default.fetch_assignment.ExchangeFetchAssi...
A plugin for fetching assignments.
- ExchangeFactory.fetch_feedbackType
Default:
'nbgrader.exchange.default.fetch_feedback.ExchangeFetchFeedback'
A plugin for fetching feedback.
- ExchangeFactory.listType
Default:
'nbgrader.exchange.default.list.ExchangeList'
A plugin for listing exchange files.
- ExchangeFactory.release_assignmentType
Default:
'nbgrader.exchange.default.release_assignment.ExchangeRelease...
A plugin for releasing assignments.
- ExchangeFactory.release_feedbackType
Default:
'nbgrader.exchange.default.release_feedback.ExchangeReleaseFe...
A plugin for releasing feedback.
- ExchangeFactory.submitType
Default:
'nbgrader.exchange.default.submit.ExchangeSubmit'
A plugin for submitting assignments.
- CourseDirectory.assignment_idUnicode
Default:
''
The assignment name. This MUST be specified, either by setting the config option, passing an argument on the command line, or using the –assignment option on the command line.
- CourseDirectory.autograded_directoryUnicode
Default:
'autograded'
The name of the directory that contains assignment submissions after they have been autograded. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.course_idUnicode
Default:
''
A key that is unique per instructor and course. This can be specified, either by setting the config option, or using the –course option on the command line.
- CourseDirectory.db_urlUnicode
Default:
''
URL to the database. Defaults to sqlite:///<root>/gradebook.db, where <root> is another configurable variable.
- CourseDirectory.directory_structureUnicode
Default:
'{nbgrader_step}/{student_id}/{assignment_id}'
Format string for the directory structure that nbgrader works over during the grading process. This MUST contain named keys for ‘nbgrader_step’, ‘student_id’, and ‘assignment_id’. It SHOULD NOT contain a key for ‘notebook_id’, as this will be automatically joined with the rest of the path.
- CourseDirectory.feedback_directoryUnicode
Default:
'feedback'
The name of the directory that contains assignment feedback after grading has been completed. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.groupsharedBool
Default:
False
Make all instructor files group writeable (g+ws, default g+r only) and exchange directories group readable/writeable (g+rws, default g=nothing only ) by default. This should only be used if you carefully set the primary groups of your notebook servers and fully understand the unix permission model. This changes the default permissions from 444 (unwriteable) to 664 (writeable), so that other instructors are able to delete/overwrite files.
- CourseDirectory.ignoreList
Default:
['.ipynb_checkpoints', '*.pyc', '__pycache__', 'feedback']
List of file names or file globs. Upon copying directories recursively, matching files and directories will be ignored with a debug message.
- CourseDirectory.includeList
Default:
['*']
List of file names or file globs. Upon copying directories recursively, non matching files will be ignored with a debug message.
- CourseDirectory.max_dir_sizeInt
Default:
100000
Maximum size of directories (in kilobytes; default: 100Mb). Upon copying directories recursively, larger files will be ignored with a warning.
- CourseDirectory.max_file_sizeInt
Default:
100000
Maximum size of files (in kilobytes; default: 100Mb). Upon copying directories recursively, larger files will be ignored with a warning.
- CourseDirectory.notebook_idUnicode
Default:
'*'
File glob to match notebook names, excluding the ‘.ipynb’ extension. This can be changed to filter by notebook.
- CourseDirectory.release_directoryUnicode
Default:
'release'
The name of the directory that contains the version of the assignment that will be released to students. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.rootUnicode
Default:
''
The root directory for the course files (that includes the source, release, submitted, autograded, etc. directories). Defaults to the current working directory.
- CourseDirectory.solution_directoryUnicode
Default:
'solution'
The name of the directory that contains the assignment solution after grading has been completed. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.source_directoryUnicode
Default:
'source'
The name of the directory that contains the master/instructor version of assignments. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.source_with_tests_directoryUnicode
Default:
'source_with_tests'
The name of the directory that contains notebooks with both solutions and instantiated test code (i.e., all AUTOTEST directives are removed and replaced by actual test code). This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.student_idUnicode
Default:
'*'
File glob to match student IDs. This can be changed to filter by student. Note: this is always changed to ‘.’ when running nbgrader assign, as the assign step doesn’t have any student ID associated with it. With nbgrader submit, this instead forces the use of an alternative student ID for the submission. See nbgrader submit –help.
If the ID is purely numeric and you are passing it as a flag on the command line, you will need to escape the quotes in order to have it detected as a string, for example –student=””12345””. See:
for more details.
- CourseDirectory.student_id_excludeUnicode
Default:
''
Comma-separated list of student IDs to exclude. Counterpart of student_id.
This is useful when running commands on all students, but certain students cause errors or otherwise must be left out. Works at least for autograde, generate_feedback, and release_feedback.
- CourseDirectory.submitted_directoryUnicode
Default:
'submitted'
The name of the directory that contains assignments that have been submitted by students for grading. This corresponds to the nbgrader_step variable in the directory_structure config option.
- Authenticator.plugin_classType
Default:
'nbgrader.auth.base.NoAuthPlugin'
A plugin for different authentication methods.
- GenerateAssignmentApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- GenerateAssignmentApp.config_fileUnicode
Default:
''
Full path of a config file.
- GenerateAssignmentApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- GenerateAssignmentApp.generate_configBool
Default:
False
Generate default config file.
- GenerateAssignmentApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- GenerateAssignmentApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- GenerateAssignmentApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- GenerateAssignmentApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- GenerateAssignmentApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- GenerateAssignmentApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- GenerateAssignmentApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- GenerateAssignmentApp.source_with_testsBool
Default:
False
Generate intermediate notebooks that contain both the autogenerated test code and the solutions. Results will be saved in the source_with_tests/ folder. This is useful for instructors to debug issues in autogenerated test code.
- AssignApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- AssignApp.config_fileUnicode
Default:
''
Full path of a config file.
- AssignApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- AssignApp.generate_configBool
Default:
False
Generate default config file.
- AssignApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- AssignApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- AssignApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- AssignApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- AssignApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- AssignApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- AssignApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- AssignApp.source_with_testsBool
Default:
False
Generate intermediate notebooks that contain both the autogenerated test code and the solutions. Results will be saved in the source_with_tests/ folder. This is useful for instructors to debug issues in autogenerated test code.
- AutogradeApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- AutogradeApp.config_fileUnicode
Default:
''
Full path of a config file.
- AutogradeApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- AutogradeApp.generate_configBool
Default:
False
Generate default config file.
- AutogradeApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- AutogradeApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- AutogradeApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- AutogradeApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- AutogradeApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- AutogradeApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- AutogradeApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- FormgradeApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- FormgradeApp.config_fileUnicode
Default:
''
Full path of a config file.
- FormgradeApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- FormgradeApp.generate_configBool
Default:
False
Generate default config file.
- FormgradeApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- FormgradeApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- FormgradeApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- FormgradeApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- FormgradeApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- FormgradeApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- FormgradeApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- GenerateFeedbackApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- GenerateFeedbackApp.config_fileUnicode
Default:
''
Full path of a config file.
- GenerateFeedbackApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- GenerateFeedbackApp.generate_configBool
Default:
False
Generate default config file.
- GenerateFeedbackApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- GenerateFeedbackApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- GenerateFeedbackApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- GenerateFeedbackApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- GenerateFeedbackApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- GenerateFeedbackApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- GenerateFeedbackApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- FeedbackApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- FeedbackApp.config_fileUnicode
Default:
''
Full path of a config file.
- FeedbackApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- FeedbackApp.generate_configBool
Default:
False
Generate default config file.
- FeedbackApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- FeedbackApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- FeedbackApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- FeedbackApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- FeedbackApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- FeedbackApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- FeedbackApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ValidateApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- ValidateApp.config_fileUnicode
Default:
''
Full path of a config file.
- ValidateApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- ValidateApp.generate_configBool
Default:
False
Generate default config file.
- ValidateApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- ValidateApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- ValidateApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- ValidateApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- ValidateApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- ValidateApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- ValidateApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ReleaseAssignmentApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- ReleaseAssignmentApp.config_fileUnicode
Default:
''
Full path of a config file.
- ReleaseAssignmentApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- ReleaseAssignmentApp.generate_configBool
Default:
False
Generate default config file.
- ReleaseAssignmentApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- ReleaseAssignmentApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- ReleaseAssignmentApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- ReleaseAssignmentApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- ReleaseAssignmentApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- ReleaseAssignmentApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- ReleaseAssignmentApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ReleaseApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- ReleaseApp.config_fileUnicode
Default:
''
Full path of a config file.
- ReleaseApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- ReleaseApp.generate_configBool
Default:
False
Generate default config file.
- ReleaseApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- ReleaseApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- ReleaseApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- ReleaseApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- ReleaseApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- ReleaseApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- ReleaseApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ReleaseFeedbackApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- ReleaseFeedbackApp.config_fileUnicode
Default:
''
Full path of a config file.
- ReleaseFeedbackApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- ReleaseFeedbackApp.generate_configBool
Default:
False
Generate default config file.
- ReleaseFeedbackApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- ReleaseFeedbackApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- ReleaseFeedbackApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- ReleaseFeedbackApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- ReleaseFeedbackApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- ReleaseFeedbackApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- ReleaseFeedbackApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- CollectApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- CollectApp.config_fileUnicode
Default:
''
Full path of a config file.
- CollectApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- CollectApp.generate_configBool
Default:
False
Generate default config file.
- CollectApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- CollectApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- CollectApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- CollectApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- CollectApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- CollectApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- CollectApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ZipCollectApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- ZipCollectApp.archive_directoryUnicode
Default:
'archive'
The name of the directory that contains assignment submission files and/or archives (zip) files manually downloaded from a LMS. This corresponds to the collect_step variable in the collect_structure config option.
- ZipCollectApp.collect_directory_structureUnicode
Default:
'{downloaded}/{assignment_id}/{collect_step}'
Format string for the directory structure that nbgrader works over during the zip collect process. This MUST contain named keys for ‘downloaded’, ‘assignment_id’, and ‘collect_step’.
- ZipCollectApp.collector_pluginType
Default:
'nbgrader.plugins.zipcollect.FileNameCollectorPlugin'
The plugin class for processing the submitted file names after they have been extracted into the extracted_directory.
- ZipCollectApp.config_fileUnicode
Default:
''
Full path of a config file.
- ZipCollectApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- ZipCollectApp.downloaded_directoryUnicode
Default:
'downloaded'
The main directory that corresponds to the downloaded variable in the collect_structure config option.
- ZipCollectApp.extracted_directoryUnicode
Default:
'extracted'
The name of the directory that contains assignment submission files extracted or copied from the archive_directory. This corresponds to the collect_step variable in the collect_structure config option.
- ZipCollectApp.extractor_pluginType
Default:
'nbgrader.plugins.zipcollect.ExtractorPlugin'
The plugin class for extracting the archive files in the archive_directory.
- ZipCollectApp.forceBool
Default:
False
Force overwrite of existing files.
- ZipCollectApp.generate_configBool
Default:
False
Generate default config file.
- ZipCollectApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- ZipCollectApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- ZipCollectApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- ZipCollectApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- ZipCollectApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- ZipCollectApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- ZipCollectApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ZipCollectApp.strictBool
Default:
False
Skip submitted notebooks with invalid names.
- FetchAssignmentApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- FetchAssignmentApp.config_fileUnicode
Default:
''
Full path of a config file.
- FetchAssignmentApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- FetchAssignmentApp.generate_configBool
Default:
False
Generate default config file.
- FetchAssignmentApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- FetchAssignmentApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- FetchAssignmentApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- FetchAssignmentApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- FetchAssignmentApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- FetchAssignmentApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- FetchAssignmentApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- FetchApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- FetchApp.config_fileUnicode
Default:
''
Full path of a config file.
- FetchApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- FetchApp.generate_configBool
Default:
False
Generate default config file.
- FetchApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- FetchApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- FetchApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- FetchApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- FetchApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- FetchApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- FetchApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- FetchFeedbackApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- FetchFeedbackApp.config_fileUnicode
Default:
''
Full path of a config file.
- FetchFeedbackApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- FetchFeedbackApp.generate_configBool
Default:
False
Generate default config file.
- FetchFeedbackApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- FetchFeedbackApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- FetchFeedbackApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- FetchFeedbackApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- FetchFeedbackApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- FetchFeedbackApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- FetchFeedbackApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- SubmitApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- SubmitApp.config_fileUnicode
Default:
''
Full path of a config file.
- SubmitApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- SubmitApp.generate_configBool
Default:
False
Generate default config file.
- SubmitApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- SubmitApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- SubmitApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- SubmitApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- SubmitApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- SubmitApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- SubmitApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ListApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- ListApp.config_fileUnicode
Default:
''
Full path of a config file.
- ListApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- ListApp.generate_configBool
Default:
False
Generate default config file.
- ListApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- ListApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- ListApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- ListApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- ListApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- ListApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- ListApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ExtensionApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- ExtensionApp.config_fileUnicode
Default:
''
Full path of a config file.
- ExtensionApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- ExtensionApp.generate_configBool
Default:
False
Generate default config file.
- ExtensionApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- ExtensionApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- ExtensionApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- ExtensionApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- ExtensionApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- ExtensionApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- ExtensionApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- QuickStartApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- QuickStartApp.autotestBool
Default:
False
Whether to use automatic test generation in example files
- QuickStartApp.config_fileUnicode
Default:
''
Full path of a config file.
- QuickStartApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- QuickStartApp.forceBool
Default:
False
Whether to overwrite existing files
- QuickStartApp.generate_configBool
Default:
False
Generate default config file.
- QuickStartApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- QuickStartApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- QuickStartApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- QuickStartApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- QuickStartApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- QuickStartApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- QuickStartApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ExportApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- ExportApp.config_fileUnicode
Default:
''
Full path of a config file.
- ExportApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- ExportApp.generate_configBool
Default:
False
Generate default config file.
- ExportApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- ExportApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- ExportApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- ExportApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- ExportApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- ExportApp.plugin_classType
Default:
'nbgrader.plugins.export.CsvExportPlugin'
The plugin class for exporting the grades.
- ExportApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- ExportApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- DbBaseApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- DbBaseApp.config_fileUnicode
Default:
''
Full path of a config file.
- DbBaseApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- DbBaseApp.generate_configBool
Default:
False
Generate default config file.
- DbBaseApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- DbBaseApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- DbBaseApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- DbBaseApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- DbBaseApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- DbBaseApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- DbBaseApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- DbApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- DbApp.config_fileUnicode
Default:
''
Full path of a config file.
- DbApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- DbApp.generate_configBool
Default:
False
Generate default config file.
- DbApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- DbApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- DbApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- DbApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- DbApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- DbApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- DbApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- UpdateApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- UpdateApp.config_fileUnicode
Default:
''
Full path of a config file.
- UpdateApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- UpdateApp.generate_configBool
Default:
False
Generate default config file.
- UpdateApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- UpdateApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- UpdateApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- UpdateApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- UpdateApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- UpdateApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- UpdateApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- UpdateApp.validateBool
Default:
True
whether to validate metadata after updating it
- GenerateConfigApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- GenerateConfigApp.config_fileUnicode
Default:
''
Full path of a config file.
- GenerateConfigApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- GenerateConfigApp.filenameUnicode
Default:
'nbgrader_config.py'
The name of the configuration file to generate.
- GenerateConfigApp.generate_configBool
Default:
False
Generate default config file.
- GenerateConfigApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- GenerateConfigApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- GenerateConfigApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- GenerateConfigApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- GenerateConfigApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- GenerateConfigApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- GenerateConfigApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- GenerateSolutionApp.answer_yesBool
Default:
False
Answer yes to any prompts.
- GenerateSolutionApp.config_fileUnicode
Default:
''
Full path of a config file.
- GenerateSolutionApp.config_file_nameUnicode
Default:
''
Specify a config file to load.
- GenerateSolutionApp.generate_configBool
Default:
False
Generate default config file.
- GenerateSolutionApp.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- GenerateSolutionApp.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- GenerateSolutionApp.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- GenerateSolutionApp.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- GenerateSolutionApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- GenerateSolutionApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- GenerateSolutionApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ExportPlugin.assignmentList
Default:
[]
list of assignments to export
- ExportPlugin.studentList
Default:
[]
list of students to export
- ExportPlugin.toUnicode
Default:
''
destination to export to
- CsvExportPlugin.assignmentList
Default:
[]
list of assignments to export
- CsvExportPlugin.studentList
Default:
[]
list of students to export
- CsvExportPlugin.toUnicode
Default:
''
destination to export to
- ExtractorPlugin.forceBool
Default:
False
Force overwrite of existing files.
- ExtractorPlugin.zip_extList
Default:
['.zip', '.gz']
List of valid archive (zip) filename extensions to extract. Any archive (zip) files with an extension not in this list are copied to the extracted_directory.
- FileNameCollectorPlugin.named_regexpUnicode
Default:
''
This regular expression is applied to each submission filename and MUST be supplied by the instructor. This regular expression MUST provide the (?P<student_id>…) and (?P<file_id>…) named group expressions. Optionally this regular expression can also provide the (?P<first_name>…), (?P<last_name>…), (?P<email>…), and (?P<timestamp>…) named group expressions. For example if the filename is:
ps1_bitdiddle_attempt_2016-01-30-15-00-00_problem1.ipynb
then this named_regexp could be:
“.*_(?P<student_id>w+)_attempt_(?P<timestamp>[0-9-]+)_(?P<file_id>w+)”
For named group regular expression examples see https://docs.python.org/3/howto/regex.html
- FileNameCollectorPlugin.valid_extList
Default:
['.ipynb']
List of valid submission filename extensions to collect. Any submitted file with an extension not in this list is skipped.
- LateSubmissionPlugin.penalty_methodany of
'none'``|
’zero’`` Default:
'none'
- The method for assigning late submission penalties:
‘none’: do nothing (no penalty assigned) ‘zero’: assign an overall score of zero (penalty = score)
- NbConvertBase.default_languageUnicode
Default:
'ipython'
Deprecated default highlight language as of 5.0, please use language_info metadata instead
- NbConvertBase.display_data_priorityList
Default:
['text/html', 'application/pdf', 'text/latex', 'image/svg+xml...
An ordered list of preferred output type, the first encountered will usually be used when converting discarding the others.
- Preprocessor.default_languageUnicode
Default:
'ipython'
Deprecated default highlight language as of 5.0, please use language_info metadata instead
- Preprocessor.display_data_priorityList
Default:
['text/html', 'application/pdf', 'text/latex', 'image/svg+xml...
An ordered list of preferred output type, the first encountered will usually be used when converting discarding the others.
- Preprocessor.enabledBool
Default:
False
No description
- NbGraderPreprocessor.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- AssignLatePenalties.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- AssignLatePenalties.plugin_classType
Default:
'nbgrader.plugins.latesubmission.LateSubmissionPlugin'
The plugin class for assigning the late penalty for each notebook.
- IncludeHeaderFooter.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- IncludeHeaderFooter.footerUnicode
Default:
''
Path to footer notebook, relative to the root of the course directory
- IncludeHeaderFooter.headerUnicode
Default:
''
Path to header notebook, relative to the root of the course directory
- LockCells.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- LockCells.lock_all_cellsBool
Default:
False
Whether all assignment cells are locked (non-deletable and non-editable)
- LockCells.lock_grade_cellsBool
Default:
True
Whether grade cells are locked (non-deletable)
- LockCells.lock_readonly_cellsBool
Default:
True
Whether readonly cells are locked (non-deletable and non-editable)
- LockCells.lock_solution_cellsBool
Default:
True
Whether solution cells are locked (non-deletable and non-editable)
- ClearSolutions.begin_solution_delimeterUnicode
Default:
'BEGIN SOLUTION'
The delimiter marking the beginning of a solution
- ClearSolutions.code_stubDict
Default:
{'python': '# YOUR CODE HERE\\nraise NotImplementedError()', '...
The code snippet that will replace code solutions
- ClearSolutions.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- ClearSolutions.end_solution_delimeterUnicode
Default:
'END SOLUTION'
The delimiter marking the end of a solution
- ClearSolutions.enforce_metadataBool
Default:
True
Whether or not to complain if cells containing solutions regions are not marked as solution cells. WARNING: this will potentially cause things to break if you are using the full nbgrader pipeline. ONLY disable this option if you are only ever planning to use nbgrader assign.
- ClearSolutions.text_stubUnicode
Default:
'YOUR ANSWER HERE'
The text snippet that will replace written solutions
- SaveAutoGrades.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- ComputeChecksums.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- SaveCells.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- OverwriteCells.add_missing_cellsBool
Default:
False
Whether or not missing grade_cells should be added back to the notebooks being graded.
- OverwriteCells.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- OverwriteCells.missing_cell_notificationUnicode
Default:
'This cell (id:{cell_id}) was missing from the submission. It...
A text to add at the beginning of every missing cell re-added to the notebook during autograding.
- CheckCellMetadata.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- NotebookClient.allow_error_namesList
Default:
[]
List of error names which won’t stop the execution. Use this if the
allow_errors
option it too general and you want to allow only specific kinds of errors.- NotebookClient.allow_errorsBool
Default:
False
If
False
(default), when a cell raises an error the execution is stopped and aCellExecutionError
is raised, except if the error name is inallow_error_names
. IfTrue
, execution errors are ignored and the execution is continued until the end of the notebook. Output from exceptions is included in the cell output in both cases.- NotebookClient.display_data_priorityList
Default:
['text/html', 'application/pdf', 'text/latex', 'image/svg+xml...
An ordered list of preferred output type, the first encountered will usually be used when converting discarding the others.
- NotebookClient.error_on_timeoutDict
Default:
None
If a cell execution was interrupted after a timeout, don’t wait for the execute_reply from the kernel (e.g. KeyboardInterrupt error). Instead, return an execute_reply with the given error, which should be of the following form:
{ 'ename': str, # Exception name, as a string 'evalue': str, # Exception value, as a string 'traceback': list(str), # traceback frames, as strings }
- NotebookClient.extra_argumentsList
Default:
[]
No description
- NotebookClient.force_raise_errorsBool
Default:
False
If False (default), errors from executing the notebook can be allowed with a
raises-exception
tag on a single cell, or theallow_errors
orallow_error_names
configurable options for all cells. An allowed error will be recorded in notebook output, and execution will continue. If an error occurs when it is not explicitly allowed, aCellExecutionError
will be raised. If True,CellExecutionError
will be raised for any error that occurs while executing the notebook. This overrides theallow_errors
andallow_error_names
options and theraises-exception
cell tag.- NotebookClient.interrupt_on_timeoutBool
Default:
False
If execution of a cell times out, interrupt the kernel and continue executing other cells rather than throwing an error and stopping.
- NotebookClient.iopub_timeoutInt
Default:
4
The time to wait (in seconds) for IOPub output. This generally doesn’t need to be set, but on some slow networks (such as CI systems) the default timeout might not be long enough to get all messages.
- NotebookClient.ipython_hist_fileUnicode
Default:
':memory:'
Path to file to use for SQLite history database for an IPython kernel.
The specific value
:memory:
(including the colon at both end but not the back ticks), avoids creating a history file. Otherwise, IPython will create a history file for each kernel.When running kernels simultaneously (e.g. via multiprocessing) saving history a single SQLite file can result in database errors, so using
:memory:
is recommended in non-interactive contexts.- NotebookClient.kernel_manager_classType
Default:
'jupyter_client.manager.KernelManager'
The kernel manager class to use.
- NotebookClient.kernel_nameUnicode
Default:
''
Name of kernel to use to execute the cells. If not set, use the kernel_spec embedded in the notebook.
- NotebookClient.on_cell_completeCallable
Default:
None
A callable which executes after a cell execution is complete. It is called even when a cell results in a failure. Called with kwargs
cell
andcell_index
.- NotebookClient.on_cell_errorCallable
Default:
None
A callable which executes when a cell execution results in an error. This is executed even if errors are suppressed with
cell_allows_errors
. Called with kwargscell`, ``cell_index
andexecute_reply
.- NotebookClient.on_cell_executeCallable
Default:
None
A callable which executes just before a code cell is executed. Called with kwargs
cell
andcell_index
.- NotebookClient.on_cell_executedCallable
Default:
None
A callable which executes just after a code cell is executed, whether or not it results in an error. Called with kwargs
cell
,cell_index
andexecute_reply
.- NotebookClient.on_cell_startCallable
Default:
None
A callable which executes before a cell is executed and before non-executing cells are skipped. Called with kwargs
cell
andcell_index
.- NotebookClient.on_notebook_completeCallable
Default:
None
A callable which executes after the kernel is cleaned up. Called with kwargs
notebook
.- NotebookClient.on_notebook_errorCallable
Default:
None
A callable which executes when the notebook encounters an error. Called with kwargs
notebook
.- NotebookClient.on_notebook_startCallable
Default:
None
A callable which executes after the kernel manager and kernel client are setup, and cells are about to execute. Called with kwargs
notebook
.- NotebookClient.raise_on_iopub_timeoutBool
Default:
False
If
False
(default), then the kernel will continue waiting for iopub messages until it receives a kernel idle message, or until a timeout occurs, at which point the currently executing cell will be skipped. IfTrue
, then an error will be raised after the first timeout. This option generally does not need to be used, but may be useful in contexts where there is the possibility of executing notebooks with memory-consuming infinite loops.- NotebookClient.record_timingBool
Default:
True
If
True
(default), then the execution timings of each cell will be stored in the metadata of the notebook.- NotebookClient.shell_timeout_intervalInt
Default:
5
The time to wait (in seconds) for Shell output before retrying. This generally doesn’t need to be set, but if one needs to check for dead kernels at a faster rate this can help.
- NotebookClient.shutdown_kernelany of
'graceful'``|
’immediate’`` Default:
'graceful'
If
graceful
(default), then the kernel is given time to clean up after executing all cells, e.g., to execute itsatexit
hooks. Ifimmediate
, then the kernel is signaled to immediately terminate.- NotebookClient.skip_cells_with_tagUnicode
Default:
'skip-execution'
Name of the cell tag to use to denote a cell that should be skipped.
- NotebookClient.startup_timeoutInt
Default:
60
The time to wait (in seconds) for the kernel to start. If kernel startup takes longer, a RuntimeError is raised.
- NotebookClient.store_widget_stateBool
Default:
True
If
True
(default), then the state of the Jupyter widgets created at the kernel will be stored in the metadata of the notebook.- NotebookClient.timeoutInt
Default:
None
The time to wait (in seconds) for output from executions. If a cell execution takes longer, a TimeoutError is raised.
None
or-1
will disable the timeout. Iftimeout_func
is set, it overridestimeout
.- NotebookClient.timeout_funcAny
Default:
None
A callable which, when given the cell source as input, returns the time to wait (in seconds) for output from cell executions. If a cell execution takes longer, a TimeoutError is raised.
Returning
None
or-1
will disable the timeout for the cell. Not settingtimeout_func
will cause the client to default to using thetimeout
trait for all cells. Thetimeout_func
trait overridestimeout
if it is notNone
.- ExecutePreprocessor.allow_error_namesList
Default:
[]
List of error names which won’t stop the execution. Use this if the
allow_errors
option it too general and you want to allow only specific kinds of errors.- ExecutePreprocessor.allow_errorsBool
Default:
False
If
False
(default), when a cell raises an error the execution is stopped and aCellExecutionError
is raised, except if the error name is inallow_error_names
. IfTrue
, execution errors are ignored and the execution is continued until the end of the notebook. Output from exceptions is included in the cell output in both cases.- ExecutePreprocessor.default_languageUnicode
Default:
'ipython'
Deprecated default highlight language as of 5.0, please use language_info metadata instead
- ExecutePreprocessor.display_data_priorityList
Default:
['text/html', 'application/pdf', 'text/latex', 'image/svg+xml...
An ordered list of preferred output type, the first encountered will usually be used when converting discarding the others.
- ExecutePreprocessor.enabledBool
Default:
False
No description
- ExecutePreprocessor.error_on_timeoutDict
Default:
None
If a cell execution was interrupted after a timeout, don’t wait for the execute_reply from the kernel (e.g. KeyboardInterrupt error). Instead, return an execute_reply with the given error, which should be of the following form:
{ 'ename': str, # Exception name, as a string 'evalue': str, # Exception value, as a string 'traceback': list(str), # traceback frames, as strings }
- ExecutePreprocessor.extra_argumentsList
Default:
[]
No description
- ExecutePreprocessor.force_raise_errorsBool
Default:
False
If False (default), errors from executing the notebook can be allowed with a
raises-exception
tag on a single cell, or theallow_errors
orallow_error_names
configurable options for all cells. An allowed error will be recorded in notebook output, and execution will continue. If an error occurs when it is not explicitly allowed, aCellExecutionError
will be raised. If True,CellExecutionError
will be raised for any error that occurs while executing the notebook. This overrides theallow_errors
andallow_error_names
options and theraises-exception
cell tag.- ExecutePreprocessor.interrupt_on_timeoutBool
Default:
False
If execution of a cell times out, interrupt the kernel and continue executing other cells rather than throwing an error and stopping.
- ExecutePreprocessor.iopub_timeoutInt
Default:
4
The time to wait (in seconds) for IOPub output. This generally doesn’t need to be set, but on some slow networks (such as CI systems) the default timeout might not be long enough to get all messages.
- ExecutePreprocessor.ipython_hist_fileUnicode
Default:
':memory:'
Path to file to use for SQLite history database for an IPython kernel.
The specific value
:memory:
(including the colon at both end but not the back ticks), avoids creating a history file. Otherwise, IPython will create a history file for each kernel.When running kernels simultaneously (e.g. via multiprocessing) saving history a single SQLite file can result in database errors, so using
:memory:
is recommended in non-interactive contexts.- ExecutePreprocessor.kernel_manager_classType
Default:
'jupyter_client.manager.KernelManager'
The kernel manager class to use.
- ExecutePreprocessor.kernel_nameUnicode
Default:
''
Name of kernel to use to execute the cells. If not set, use the kernel_spec embedded in the notebook.
- ExecutePreprocessor.on_cell_completeCallable
Default:
None
A callable which executes after a cell execution is complete. It is called even when a cell results in a failure. Called with kwargs
cell
andcell_index
.- ExecutePreprocessor.on_cell_errorCallable
Default:
None
A callable which executes when a cell execution results in an error. This is executed even if errors are suppressed with
cell_allows_errors
. Called with kwargscell`, ``cell_index
andexecute_reply
.- ExecutePreprocessor.on_cell_executeCallable
Default:
None
A callable which executes just before a code cell is executed. Called with kwargs
cell
andcell_index
.- ExecutePreprocessor.on_cell_executedCallable
Default:
None
A callable which executes just after a code cell is executed, whether or not it results in an error. Called with kwargs
cell
,cell_index
andexecute_reply
.- ExecutePreprocessor.on_cell_startCallable
Default:
None
A callable which executes before a cell is executed and before non-executing cells are skipped. Called with kwargs
cell
andcell_index
.- ExecutePreprocessor.on_notebook_completeCallable
Default:
None
A callable which executes after the kernel is cleaned up. Called with kwargs
notebook
.- ExecutePreprocessor.on_notebook_errorCallable
Default:
None
A callable which executes when the notebook encounters an error. Called with kwargs
notebook
.- ExecutePreprocessor.on_notebook_startCallable
Default:
None
A callable which executes after the kernel manager and kernel client are setup, and cells are about to execute. Called with kwargs
notebook
.- ExecutePreprocessor.raise_on_iopub_timeoutBool
Default:
False
If
False
(default), then the kernel will continue waiting for iopub messages until it receives a kernel idle message, or until a timeout occurs, at which point the currently executing cell will be skipped. IfTrue
, then an error will be raised after the first timeout. This option generally does not need to be used, but may be useful in contexts where there is the possibility of executing notebooks with memory-consuming infinite loops.- ExecutePreprocessor.record_timingBool
Default:
True
If
True
(default), then the execution timings of each cell will be stored in the metadata of the notebook.- ExecutePreprocessor.shell_timeout_intervalInt
Default:
5
The time to wait (in seconds) for Shell output before retrying. This generally doesn’t need to be set, but if one needs to check for dead kernels at a faster rate this can help.
- ExecutePreprocessor.shutdown_kernelany of
'graceful'``|
’immediate’`` Default:
'graceful'
If
graceful
(default), then the kernel is given time to clean up after executing all cells, e.g., to execute itsatexit
hooks. Ifimmediate
, then the kernel is signaled to immediately terminate.- ExecutePreprocessor.skip_cells_with_tagUnicode
Default:
'skip-execution'
Name of the cell tag to use to denote a cell that should be skipped.
- ExecutePreprocessor.startup_timeoutInt
Default:
60
The time to wait (in seconds) for the kernel to start. If kernel startup takes longer, a RuntimeError is raised.
- ExecutePreprocessor.store_widget_stateBool
Default:
True
If
True
(default), then the state of the Jupyter widgets created at the kernel will be stored in the metadata of the notebook.- ExecutePreprocessor.timeoutInt
Default:
None
The time to wait (in seconds) for output from executions. If a cell execution takes longer, a TimeoutError is raised.
None
or-1
will disable the timeout. Iftimeout_func
is set, it overridestimeout
.- ExecutePreprocessor.timeout_funcAny
Default:
None
A callable which, when given the cell source as input, returns the time to wait (in seconds) for output from cell executions. If a cell execution takes longer, a TimeoutError is raised.
Returning
None
or-1
will disable the timeout for the cell. Not settingtimeout_func
will cause the client to default to using thetimeout
trait for all cells. Thetimeout_func
trait overridestimeout
if it is notNone
.- Execute.allow_error_namesList
Default:
[]
List of error names which won’t stop the execution. Use this if the
allow_errors
option it too general and you want to allow only specific kinds of errors.- Execute.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- Execute.error_on_timeoutDict
Default:
{'ename': 'CellTimeoutError', 'evalue': '', 'traceback': ['\x...
If a cell execution was interrupted after a timeout, don’t wait for the execute_reply from the kernel (e.g. KeyboardInterrupt error). Instead, return an execute_reply with the given error, which should be of the following form:
{ 'ename': str, # Exception name, as a string 'evalue': str, # Exception value, as a string 'traceback': list(str), # traceback frames, as strings }
- Execute.execute_retriesInt
Default:
0
The number of times to try re-executing the notebook before throwing an error. Generally, this shouldn’t need to be set, but might be useful for CI environments when tests are flaky.
- Execute.extra_argumentsList
Default:
[]
A list of extra arguments to pass to the kernel. For python kernels, this defaults to
--HistoryManager.hist_file=:memory:
. For other kernels this is just an empty list.- Execute.force_raise_errorsBool
Default:
False
If False (default), errors from executing the notebook can be allowed with a
raises-exception
tag on a single cell, or theallow_errors
orallow_error_names
configurable options for all cells. An allowed error will be recorded in notebook output, and execution will continue. If an error occurs when it is not explicitly allowed, aCellExecutionError
will be raised. If True,CellExecutionError
will be raised for any error that occurs while executing the notebook. This overrides theallow_errors
andallow_error_names
options and theraises-exception
cell tag.- Execute.interrupt_on_timeoutBool
Default:
True
If execution of a cell times out, interrupt the kernel and continue executing other cells rather than throwing an error and stopping.
- Execute.iopub_timeoutInt
Default:
4
The time to wait (in seconds) for IOPub output. This generally doesn’t need to be set, but on some slow networks (such as CI systems) the default timeout might not be long enough to get all messages.
- Execute.ipython_hist_fileUnicode
Default:
':memory:'
Path to file to use for SQLite history database for an IPython kernel.
The specific value
:memory:
(including the colon at both end but not the back ticks), avoids creating a history file. Otherwise, IPython will create a history file for each kernel.When running kernels simultaneously (e.g. via multiprocessing) saving history a single SQLite file can result in database errors, so using
:memory:
is recommended in non-interactive contexts.- Execute.kernel_manager_classType
Default:
'jupyter_client.manager.KernelManager'
The kernel manager class to use.
- Execute.kernel_nameUnicode
Default:
''
Name of kernel to use to execute the cells. If not set, use the kernel_spec embedded in the notebook.
- Execute.on_cell_completeCallable
Default:
None
A callable which executes after a cell execution is complete. It is called even when a cell results in a failure. Called with kwargs
cell
andcell_index
.- Execute.on_cell_errorCallable
Default:
None
A callable which executes when a cell execution results in an error. This is executed even if errors are suppressed with
cell_allows_errors
. Called with kwargscell`, ``cell_index
andexecute_reply
.- Execute.on_cell_executeCallable
Default:
None
A callable which executes just before a code cell is executed. Called with kwargs
cell
andcell_index
.- Execute.on_cell_startCallable
Default:
None
A callable which executes before a cell is executed and before non-executing cells are skipped. Called with kwargs
cell
andcell_index
.- Execute.on_notebook_completeCallable
Default:
None
A callable which executes after the kernel is cleaned up. Called with kwargs
notebook
.- Execute.on_notebook_errorCallable
Default:
None
A callable which executes when the notebook encounters an error. Called with kwargs
notebook
.- Execute.on_notebook_startCallable
Default:
None
A callable which executes after the kernel manager and kernel client are setup, and cells are about to execute. Called with kwargs
notebook
.- Execute.raise_on_iopub_timeoutBool
Default:
True
If
False
(default), then the kernel will continue waiting for iopub messages until it receives a kernel idle message, or until a timeout occurs, at which point the currently executing cell will be skipped. IfTrue
, then an error will be raised after the first timeout. This option generally does not need to be used, but may be useful in contexts where there is the possibility of executing notebooks with memory-consuming infinite loops.- Execute.record_timingBool
Default:
True
If
True
(default), then the execution timings of each cell will be stored in the metadata of the notebook.- Execute.shell_timeout_intervalInt
Default:
5
The time to wait (in seconds) for Shell output before retrying. This generally doesn’t need to be set, but if one needs to check for dead kernels at a faster rate this can help.
- Execute.shutdown_kernelany of
'graceful'``|
’immediate’`` Default:
'graceful'
If
graceful
(default), then the kernel is given time to clean up after executing all cells, e.g., to execute itsatexit
hooks. Ifimmediate
, then the kernel is signaled to immediately terminate.- Execute.skip_cells_with_tagUnicode
Default:
'skip-execution'
Name of the cell tag to use to denote a cell that should be skipped.
- Execute.startup_timeoutInt
Default:
60
The time to wait (in seconds) for the kernel to start. If kernel startup takes longer, a RuntimeError is raised.
- Execute.store_widget_stateBool
Default:
True
If
True
(default), then the state of the Jupyter widgets created at the kernel will be stored in the metadata of the notebook.- Execute.timeoutInt
Default:
30
The time to wait (in seconds) for output from executions. If a cell execution takes longer, a TimeoutError is raised.
None
or-1
will disable the timeout. Iftimeout_func
is set, it overridestimeout
.- Execute.timeout_funcAny
Default:
None
A callable which, when given the cell source as input, returns the time to wait (in seconds) for output from cell executions. If a cell execution takes longer, a TimeoutError is raised.
Returning
None
or-1
will disable the timeout for the cell. Not settingtimeout_func
will cause the client to default to using thetimeout
trait for all cells. Thetimeout_func
trait overridestimeout
if it is notNone
.- InstantiateTests.autotest_delimiterUnicode
Default:
'AUTOTEST'
The delimiter prior to snippets to be autotested
- InstantiateTests.autotest_filenameUnicode
Default:
'autotests.yml'
The filename where automatic testing code is stored
- InstantiateTests.comment_strsDict
Default:
{'ir': '#', 'python': '#', 'python3': '#'}
A dictionary mapping each Jupyter kernel’s name to the comment string for that kernel. For an example, one of the entries in this dictionary is “python” : “#”, because # is the comment character in python.
- InstantiateTests.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- InstantiateTests.enforce_metadataBool
Default:
True
Whether or not to complain if cells containing autotest delimiters are not marked as grade cells. WARNING: disabling this will potentially cause things to break if you are using the full nbgrader pipeline. ONLY disable this option if you are only ever planning to use nbgrader assign.
- InstantiateTests.hashed_delimiterUnicode
Default:
'HASHED'
The delimiter prior to an autotest block if snippet results should be protected by a hash function
- InstantiateTests.sanitizersDict
Default:
{'ir': <function InstantiateTests.<lambda> at 0x7f6606605f80>...
A dictionary mapping each Jupyter kernel’s name to the function that is used to sanitize the output from the kernel within InstantiateTests.
- InstantiateTests.use_saltBool
Default:
True
Whether to add a salt to digested answers
- GetGrades.display_data_priorityList
Default:
['text/html', 'application/pdf', 'text/latex', 'image/svg+xml...
No description
- GetGrades.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- ClearOutputPreprocessor.default_languageUnicode
Default:
'ipython'
Deprecated default highlight language as of 5.0, please use language_info metadata instead
- ClearOutputPreprocessor.display_data_priorityList
Default:
['text/html', 'application/pdf', 'text/latex', 'image/svg+xml...
An ordered list of preferred output type, the first encountered will usually be used when converting discarding the others.
- ClearOutputPreprocessor.enabledBool
Default:
False
No description
- ClearOutputPreprocessor.remove_metadata_fieldsSet
Default:
{'collapsed', 'scrolled'}
No description
- ClearOutput.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- ClearOutput.remove_metadata_fieldsSet
Default:
{'collapsed', 'scrolled'}
No description
- LimitOutput.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- LimitOutput.max_linesInt
Default:
1000
maximum number of lines of output (-1 means no limit)
- LimitOutput.max_tracebackInt
Default:
100
maximum number of traceback lines (-1 means no limit)
- DeduplicateIds.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- ClearHiddenTests.begin_test_delimeterUnicode
Default:
'BEGIN HIDDEN TESTS'
The delimiter marking the beginning of hidden tests cases
- ClearHiddenTests.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- ClearHiddenTests.end_test_delimeterUnicode
Default:
'END HIDDEN TESTS'
The delimiter marking the end of hidden tests cases
- ClearHiddenTests.enforce_metadataBool
Default:
True
Whether or not to complain if cells containing hidden test regions are not marked as grade cells. WARNING: this will potentially cause things to break if you are using the full nbgrader pipeline. ONLY disable this option if you are only ever planning to use nbgrader assign.
- ClearMarkScheme.begin_mark_scheme_delimeterUnicode
Default:
'BEGIN MARK SCHEME'
The delimiter marking the beginning of a marking scheme region
- ClearMarkScheme.check_attachment_leakageBool
Default:
True
Whether or not to check if a marking scheme region contains an attachment, in order to prevent leakage to student version of notebooks.
- ClearMarkScheme.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- ClearMarkScheme.end_mark_scheme_delimeterUnicode
Default:
'END MARK SCHEME'
The delimiter marking the end of a marking scheme region
- ClearMarkScheme.enforce_metadataBool
Default:
True
Whether or not to complain if cells containing marking scheme regions are not marked as task cells. WARNING: this will potentially cause things to break if you are using the full nbgrader pipeline. ONLY disable this option if you are only ever planning to use nbgrader assign.
- OverwriteKernelspec.enabledBool
Default:
True
Whether to use this preprocessor when running nbgrader
- IgnorePattern.enabledBool
Default:
False
Whether to use this preprocessor when running nbgrader
- IgnorePattern.patternUnicode
Default:
''
The regular expression to remove from stderr
- Exchange.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- Exchange.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- Exchange.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- ExchangeCollect.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- ExchangeCollect.before_duedateBool
Default:
False
Collect the last submission before due date or the last submission if no submission before due date.
- ExchangeCollect.check_ownerBool
Default:
True
Whether to cross-check the student_id with the UNIX-owner of the submitted directory.
- ExchangeCollect.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- ExchangeCollect.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- ExchangeCollect.updateBool
Default:
False
Update existing submissions with ones that have newer timestamps.
- ExchangeFetchAssignment.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- ExchangeFetchAssignment.replace_missing_filesBool
Default:
False
Whether to replace missing files on fetch
- ExchangeFetchAssignment.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- ExchangeFetchAssignment.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- ExchangeFetch.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- ExchangeFetch.replace_missing_filesBool
Default:
False
Whether to replace missing files on fetch
- ExchangeFetch.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- ExchangeFetch.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- ExchangeFetchFeedback.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- ExchangeFetchFeedback.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- ExchangeFetchFeedback.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- ExchangeList.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- ExchangeList.cachedBool
Default:
False
List assignments in submission cache.
- ExchangeList.inboundBool
Default:
False
List inbound files rather than outbound.
- ExchangeList.removeBool
Default:
False
Remove, rather than list files.
- ExchangeList.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- ExchangeList.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- ExchangeReleaseAssignment.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- ExchangeReleaseAssignment.forceBool
Default:
False
Force overwrite existing files in the exchange.
- ExchangeReleaseAssignment.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- ExchangeReleaseAssignment.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- ExchangeRelease.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- ExchangeRelease.forceBool
Default:
False
Force overwrite existing files in the exchange.
- ExchangeRelease.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- ExchangeRelease.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- ExchangeReleaseFeedback.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- ExchangeReleaseFeedback.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- ExchangeReleaseFeedback.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- ExchangeSubmit.assignment_dirUnicode
Default:
'.'
Local path for storing student assignments. Defaults to ‘.’ which is normally Jupyter’s root_dir.
- ExchangeSubmit.strictBool
Default:
False
Whether or not to submit the assignment if there are missing notebooks from the released assignment notebooks.
- ExchangeSubmit.timestamp_formatUnicode
Default:
'%Y-%m-%d %H:%M:%S.%f %Z'
Format string for timestamps
- ExchangeSubmit.timezoneUnicode
Default:
'UTC'
Timezone for recording timestamps
- BaseConverter.exporter_classType
Default:
'nbconvert.exporters.notebook.NotebookExporter'
No description
- BaseConverter.forceBool
Default:
False
Whether to overwrite existing assignments/submissions
- BaseConverter.permissionsInt
Default:
0
Permissions to set on files output by nbgrader. The default is generally read-only (444), with the exception of nbgrader generate_assignment and nbgrader generate_feedback, in which case the user also has write permission.
- BaseConverter.post_convert_hookAny
Default:
None
An optional hook function that you can implement to do some work after converting. This function is called after the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- BaseConverter.pre_convert_hookAny
Default:
None
An optional hook function that you can implement to do some bootstrapping work before converting. This function is called before the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- GenerateAssignment.create_assignmentBool
Default:
True
Whether to create the assignment at runtime if it does not already exist.
- GenerateAssignment.exporter_classType
Default:
'nbconvert.exporters.notebook.NotebookExporter'
No description
- GenerateAssignment.forceBool
Default:
False
Whether to overwrite existing assignments/submissions
- GenerateAssignment.no_databaseBool
Default:
False
Do not save information about the assignment into the database.
- GenerateAssignment.permissionsInt
Default:
0
Permissions to set on files output by nbgrader. The default is generally read-only (444), with the exception of nbgrader generate_assignment and nbgrader generate_feedback, in which case the user also has write permission.
- GenerateAssignment.post_convert_hookAny
Default:
None
An optional hook function that you can implement to do some work after converting. This function is called after the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- GenerateAssignment.pre_convert_hookAny
Default:
None
An optional hook function that you can implement to do some bootstrapping work before converting. This function is called before the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- GenerateAssignment.preprocessorsList
Default:
[<class 'nbgrader.preprocessors.headerfooter.IncludeHeaderFoo...
No description
- Assign.create_assignmentBool
Default:
True
Whether to create the assignment at runtime if it does not already exist.
- Assign.exporter_classType
Default:
'nbconvert.exporters.notebook.NotebookExporter'
No description
- Assign.forceBool
Default:
False
Whether to overwrite existing assignments/submissions
- Assign.no_databaseBool
Default:
False
Do not save information about the assignment into the database.
- Assign.permissionsInt
Default:
0
Permissions to set on files output by nbgrader. The default is generally read-only (444), with the exception of nbgrader generate_assignment and nbgrader generate_feedback, in which case the user also has write permission.
- Assign.post_convert_hookAny
Default:
None
An optional hook function that you can implement to do some work after converting. This function is called after the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- Assign.pre_convert_hookAny
Default:
None
An optional hook function that you can implement to do some bootstrapping work before converting. This function is called before the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- Assign.preprocessorsList
Default:
[<class 'nbgrader.preprocessors.headerfooter.IncludeHeaderFoo...
No description
- Autograde.autograde_preprocessorsList
Default:
[<class 'nbgrader.preprocessors.execute.Execute'>, <class 'nb...
No description
- Autograde.create_studentBool
Default:
True
Whether to create the student at runtime if it does not already exist.
- Autograde.exclude_overwritingDict
Default:
{}
A dictionary with keys corresponding to assignment names and values being a list of filenames (relative to the assignment’s source directory) that should NOT be overwritten with the source version. This is to allow students to e.g. edit a python file and submit it alongside the notebooks in their assignment.
- Autograde.exporter_classType
Default:
'nbconvert.exporters.notebook.NotebookExporter'
No description
- Autograde.forceBool
Default:
False
Whether to overwrite existing assignments/submissions
- Autograde.permissionsInt
Default:
0
Permissions to set on files output by nbgrader. The default is generally read-only (444), with the exception of nbgrader generate_assignment and nbgrader generate_feedback, in which case the user also has write permission.
- Autograde.post_convert_hookAny
Default:
None
An optional hook function that you can implement to do some work after converting. This function is called after the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- Autograde.pre_convert_hookAny
Default:
None
An optional hook function that you can implement to do some bootstrapping work before converting. This function is called before the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- Autograde.sanitize_preprocessorsList
Default:
[<class 'nbgrader.preprocessors.clearoutput.ClearOutput'>, <c...
No description
- GenerateFeedback.exporter_classType
Default:
'nbconvert.exporters.notebook.NotebookExporter'
No description
- GenerateFeedback.forceBool
Default:
False
Whether to overwrite existing assignments/submissions
- GenerateFeedback.permissionsInt
Default:
0
Permissions to set on files output by nbgrader. The default is generally read-only (444), with the exception of nbgrader generate_assignment and nbgrader generate_feedback, in which case the user also has write permission.
- GenerateFeedback.post_convert_hookAny
Default:
None
An optional hook function that you can implement to do some work after converting. This function is called after the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- GenerateFeedback.pre_convert_hookAny
Default:
None
An optional hook function that you can implement to do some bootstrapping work before converting. This function is called before the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- GenerateFeedback.preprocessorsList
Default:
[<class 'nbgrader.preprocessors.getgrades.GetGrades'>, <class...
No description
- Feedback.exporter_classType
Default:
'nbconvert.exporters.notebook.NotebookExporter'
No description
- Feedback.forceBool
Default:
False
Whether to overwrite existing assignments/submissions
- Feedback.permissionsInt
Default:
0
Permissions to set on files output by nbgrader. The default is generally read-only (444), with the exception of nbgrader generate_assignment and nbgrader generate_feedback, in which case the user also has write permission.
- Feedback.post_convert_hookAny
Default:
None
An optional hook function that you can implement to do some work after converting. This function is called after the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- Feedback.pre_convert_hookAny
Default:
None
An optional hook function that you can implement to do some bootstrapping work before converting. This function is called before the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- Feedback.preprocessorsList
Default:
[<class 'nbgrader.preprocessors.getgrades.GetGrades'>, <class...
No description
- GenerateSolution.create_assignmentBool
Default:
True
Whether to create the assignment at runtime if it does not already exist.
- GenerateSolution.exporter_classType
Default:
'nbconvert.exporters.notebook.NotebookExporter'
No description
- GenerateSolution.forceBool
Default:
False
Whether to overwrite existing assignments/submissions
- GenerateSolution.permissionsInt
Default:
0
Permissions to set on files output by nbgrader. The default is generally read-only (444), with the exception of nbgrader generate_assignment and nbgrader generate_feedback, in which case the user also has write permission.
- GenerateSolution.post_convert_hookAny
Default:
None
An optional hook function that you can implement to do some work after converting. This function is called after the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- GenerateSolution.pre_convert_hookAny
Default:
None
An optional hook function that you can implement to do some bootstrapping work before converting. This function is called before the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- GenerateSolution.preprocessorsList
Default:
[<class 'nbgrader.preprocessors.headerfooter.IncludeHeaderFoo...
No description
- GenerateSourceWithTests.exporter_classType
Default:
'nbconvert.exporters.notebook.NotebookExporter'
No description
- GenerateSourceWithTests.forceBool
Default:
False
Whether to overwrite existing assignments/submissions
- GenerateSourceWithTests.permissionsInt
Default:
0
Permissions to set on files output by nbgrader. The default is generally read-only (444), with the exception of nbgrader generate_assignment and nbgrader generate_feedback, in which case the user also has write permission.
- GenerateSourceWithTests.post_convert_hookAny
Default:
None
An optional hook function that you can implement to do some work after converting. This function is called after the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- GenerateSourceWithTests.pre_convert_hookAny
Default:
None
An optional hook function that you can implement to do some bootstrapping work before converting. This function is called before the notebooks are converted and should be used for specific converters such as Autograde, GenerateAssignment or GenerateFeedback.
It will be called as (all arguments are passed as keywords):
hook(assignment=assignment, student=student, notebooks=notebooks)
- GenerateSourceWithTests.preprocessorsList
Default:
[<class 'nbgrader.preprocessors.instantiatetests.InstantiateT...
No description
- 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:
30
Set the log level by value or name.
- Application.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- Application.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- Application.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- JupyterApp.answer_yesBool
Default:
False
Answer 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:
False
Generate 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:
30
Set the log level by value or name.
- JupyterApp.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- JupyterApp.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- JupyterApp.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- NbGrader.answer_yesBool
Default:
False
Answer yes to any prompts.
- NbGrader.config_fileUnicode
Default:
''
Full path of a config file.
- NbGrader.config_file_nameUnicode
Default:
''
Specify a config file to load.
- NbGrader.generate_configBool
Default:
False
Generate default config file.
- NbGrader.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- NbGrader.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- NbGrader.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- NbGrader.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- NbGrader.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- NbGrader.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- NbGrader.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- FormgradeExtension.answer_yesBool
Default:
False
Answer yes to any prompts.
- FormgradeExtension.config_fileUnicode
Default:
''
Full path of a config file.
- FormgradeExtension.config_file_nameUnicode
Default:
''
Specify a config file to load.
- FormgradeExtension.debugBool
Default:
True
Whether to display the loaded configuration in the ‘Formgrader -> Manage Assignments’ panel. This can help debugging some misconfiguration when using several files.
- FormgradeExtension.generate_configBool
Default:
False
Generate default config file.
- FormgradeExtension.log_datefmtUnicode
Default:
'%Y-%m-%d %H:%M:%S'
The date format used by logging formatters for %(asctime)s
- FormgradeExtension.log_formatUnicode
Default:
'[%(name)s]%(highlevel)s %(message)s'
The Logging format template
- FormgradeExtension.log_levelany of
0``|``10``|``20``|``30``|``40``|``50``|
’DEBUG’|
’INFO’|
’WARN’|
’ERROR’|
’CRITICAL’`` Default:
30
Set the log level by value or name.
- FormgradeExtension.logfileUnicode
Default:
''
Name of the logfile to log to. By default, log output is not written to any file.
- FormgradeExtension.logging_configDict
Default:
{}
Configure additional log handlers.
The default stderr logs handler is configured by the log_level, log_datefmt and log_format settings.
This configuration can be used to configure additional handlers (e.g. to output the log to a file) or for finer control over the default handlers.
If provided this should be a logging configuration dictionary, for more information see: https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
This dictionary is merged with the base logging configuration which defines the following:
A logging formatter intended for interactive use called
console
.A logging handler that writes to stderr called
console
which uses the formatterconsole
.A logger with the name of this application set to
DEBUG
level.
This example adds a new handler that writes to a file:
c.Application.logging_config = { "handlers": { "file": { "class": "logging.FileHandler", "level": "DEBUG", "filename": "<path/to/file>", } }, "loggers": { "<application-name>": { "level": "DEBUG", # NOTE: if you don't list the default "console" # handler here then it will be disabled "handlers": ["console", "file"], }, }, }
- FormgradeExtension.show_configBool
Default:
False
Instead of starting the Application, dump configuration to stdout
- FormgradeExtension.show_config_jsonBool
Default:
False
Instead of starting the Application, dump configuration to stdout (as JSON)
- ExchangeFactory.collectType
Default:
'nbgrader.exchange.default.collect.ExchangeCollect'
A plugin for collecting assignments.
- ExchangeFactory.exchangeType
Default:
'nbgrader.exchange.default.exchange.Exchange'
A plugin for exchange.
- ExchangeFactory.fetch_assignmentType
Default:
'nbgrader.exchange.default.fetch_assignment.ExchangeFetchAssi...
A plugin for fetching assignments.
- ExchangeFactory.fetch_feedbackType
Default:
'nbgrader.exchange.default.fetch_feedback.ExchangeFetchFeedback'
A plugin for fetching feedback.
- ExchangeFactory.listType
Default:
'nbgrader.exchange.default.list.ExchangeList'
A plugin for listing exchange files.
- ExchangeFactory.release_assignmentType
Default:
'nbgrader.exchange.default.release_assignment.ExchangeRelease...
A plugin for releasing assignments.
- ExchangeFactory.release_feedbackType
Default:
'nbgrader.exchange.default.release_feedback.ExchangeReleaseFe...
A plugin for releasing feedback.
- ExchangeFactory.submitType
Default:
'nbgrader.exchange.default.submit.ExchangeSubmit'
A plugin for submitting assignments.
- CourseDirectory.assignment_idUnicode
Default:
''
The assignment name. This MUST be specified, either by setting the config option, passing an argument on the command line, or using the –assignment option on the command line.
- CourseDirectory.autograded_directoryUnicode
Default:
'autograded'
The name of the directory that contains assignment submissions after they have been autograded. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.course_idUnicode
Default:
''
A key that is unique per instructor and course. This can be specified, either by setting the config option, or using the –course option on the command line.
- CourseDirectory.db_urlUnicode
Default:
''
URL to the database. Defaults to sqlite:///<root>/gradebook.db, where <root> is another configurable variable.
- CourseDirectory.directory_structureUnicode
Default:
'{nbgrader_step}/{student_id}/{assignment_id}'
Format string for the directory structure that nbgrader works over during the grading process. This MUST contain named keys for ‘nbgrader_step’, ‘student_id’, and ‘assignment_id’. It SHOULD NOT contain a key for ‘notebook_id’, as this will be automatically joined with the rest of the path.
- CourseDirectory.feedback_directoryUnicode
Default:
'feedback'
The name of the directory that contains assignment feedback after grading has been completed. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.groupsharedBool
Default:
False
Make all instructor files group writeable (g+ws, default g+r only) and exchange directories group readable/writeable (g+rws, default g=nothing only ) by default. This should only be used if you carefully set the primary groups of your notebook servers and fully understand the unix permission model. This changes the default permissions from 444 (unwriteable) to 664 (writeable), so that other instructors are able to delete/overwrite files.
- CourseDirectory.ignoreList
Default:
['.ipynb_checkpoints', '*.pyc', '__pycache__', 'feedback']
List of file names or file globs. Upon copying directories recursively, matching files and directories will be ignored with a debug message.
- CourseDirectory.includeList
Default:
['*']
List of file names or file globs. Upon copying directories recursively, non matching files will be ignored with a debug message.
- CourseDirectory.max_dir_sizeInt
Default:
100000
Maximum size of directories (in kilobytes; default: 100Mb). Upon copying directories recursively, larger files will be ignored with a warning.
- CourseDirectory.max_file_sizeInt
Default:
100000
Maximum size of files (in kilobytes; default: 100Mb). Upon copying directories recursively, larger files will be ignored with a warning.
- CourseDirectory.notebook_idUnicode
Default:
'*'
File glob to match notebook names, excluding the ‘.ipynb’ extension. This can be changed to filter by notebook.
- CourseDirectory.release_directoryUnicode
Default:
'release'
The name of the directory that contains the version of the assignment that will be released to students. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.rootUnicode
Default:
''
The root directory for the course files (that includes the source, release, submitted, autograded, etc. directories). Defaults to the current working directory.
- CourseDirectory.solution_directoryUnicode
Default:
'solution'
The name of the directory that contains the assignment solution after grading has been completed. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.source_directoryUnicode
Default:
'source'
The name of the directory that contains the master/instructor version of assignments. This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.source_with_tests_directoryUnicode
Default:
'source_with_tests'
The name of the directory that contains notebooks with both solutions and instantiated test code (i.e., all AUTOTEST directives are removed and replaced by actual test code). This corresponds to the nbgrader_step variable in the directory_structure config option.
- CourseDirectory.student_idUnicode
Default:
'*'
File glob to match student IDs. This can be changed to filter by student. Note: this is always changed to ‘.’ when running nbgrader assign, as the assign step doesn’t have any student ID associated with it. With nbgrader submit, this instead forces the use of an alternative student ID for the submission. See nbgrader submit –help.
If the ID is purely numeric and you are passing it as a flag on the command line, you will need to escape the quotes in order to have it detected as a string, for example –student=””12345””. See:
for more details.
- CourseDirectory.student_id_excludeUnicode
Default:
''
Comma-separated list of student IDs to exclude. Counterpart of student_id.
This is useful when running commands on all students, but certain students cause errors or otherwise must be left out. Works at least for autograde, generate_feedback, and release_feedback.
- CourseDirectory.submitted_directoryUnicode
Default:
'submitted'
The name of the directory that contains assignments that have been submitted by students for grading. This corresponds to the nbgrader_step variable in the directory_structure config option.
- Exporter.default_preprocessorsList
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....
- List of preprocessors available by default, by name, namespace,
instance, or type.
- Exporter.enabledBool
Default:
True
Disable this exporter (and any exporters inherited from it).
- Exporter.file_extensionFilenameExtension
Default:
''
Extension of the file that should be written to disk
- Exporter.optimistic_validationBool
Default:
False
Reduces the number of validation steps so that it only occurs after all preprocesors have run.
- Exporter.preprocessorsList
Default:
[]
List of preprocessors, by name or namespace, to enable.
- TemplateExporter.default_preprocessorsList
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....
- List of preprocessors available by default, by name, namespace,
instance, or type.
- TemplateExporter.enabledBool
Default:
True
Disable this exporter (and any exporters inherited from it).
- TemplateExporter.exclude_code_cellBool
Default:
False
This allows you to exclude code cells from all templates if set to True.
- TemplateExporter.exclude_inputBool
Default:
False
This allows you to exclude code cell inputs from all templates if set to True.
- TemplateExporter.exclude_input_promptBool
Default:
False
This allows you to exclude input prompts from all templates if set to True.
- TemplateExporter.exclude_markdownBool
Default:
False
This allows you to exclude markdown cells from all templates if set to True.
- TemplateExporter.exclude_outputBool
Default:
False
This allows you to exclude code cell outputs from all templates if set to True.
- TemplateExporter.exclude_output_promptBool
Default:
False
This allows you to exclude output prompts from all templates if set to True.
- TemplateExporter.exclude_output_stdinBool
Default:
True
This allows you to exclude output of stdin stream from lab template if set to True.
- TemplateExporter.exclude_rawBool
Default:
False
This allows you to exclude raw cells from all templates if set to True.
- TemplateExporter.exclude_unknownBool
Default:
False
This allows you to exclude unknown cells from all templates if set to True.
- TemplateExporter.extra_template_basedirsList
Default:
[]
No description
- TemplateExporter.extra_template_pathsList
Default:
[]
No description
- TemplateExporter.file_extensionFilenameExtension
Default:
''
Extension of the file that should be written to disk
- TemplateExporter.filtersDict
Default:
{}
- Dictionary of filters, by name and namespace, to add to the Jinja
environment.
- TemplateExporter.optimistic_validationBool
Default:
False
Reduces the number of validation steps so that it only occurs after all preprocesors have run.
- TemplateExporter.preprocessorsList
Default:
[]
List of preprocessors, by name or namespace, to enable.
- TemplateExporter.raw_mimetypesList
Default:
[]
formats of raw cells to be included in this Exporter’s output.
- TemplateExporter.template_extensionUnicode
Default:
''
No description
- TemplateExporter.template_fileUnicode
Default:
None
Name of the template file to use
- TemplateExporter.template_nameUnicode
Default:
''
Name of the template to use
- TemplateExporter.template_pathsList
Default:
['.']
No description
- HTMLExporter.anchor_link_textUnicode
Default:
'¶'
The text used as the text for anchor links.
- HTMLExporter.default_preprocessorsList
Default:
['nbconvert.preprocessors.TagRemovePreprocessor', 'nbconvert....
- List of preprocessors available by default, by name, namespace,
instance, or type.
- HTMLExporter.embed_imagesBool
Default:
False
Whether or not to embed images as base64 in markdown cells.
- HTMLExporter.enabledBool
Default:
True
Disable this exporter (and any exporters inherited from it).
- HTMLExporter.exclude_anchor_linksBool
Default:
False
If anchor links should be included or not.
- HTMLExporter.exclude_code_cellBool
Default:
False
This allows you to exclude code cells from all templates if set to True.
- HTMLExporter.exclude_inputBool
Default:
False
This allows you to exclude code cell inputs from all templates if set to True.
- HTMLExporter.exclude_input_promptBool
Default:
False
This allows you to exclude input prompts from all templates if set to True.
- HTMLExporter.exclude_markdownBool
Default:
False
This allows you to exclude markdown cells from all templates if set to True.
- HTMLExporter.exclude_outputBool
Default:
False
This allows you to exclude code cell outputs from all templates if set to True.
- HTMLExporter.exclude_output_promptBool
Default:
False
This allows you to exclude output prompts from all templates if set to True.
- HTMLExporter.exclude_output_stdinBool
Default:
True
This allows you to exclude output of stdin stream from lab template if set to True.
- HTMLExporter.exclude_rawBool
Default:
False
This allows you to exclude raw cells from all templates if set to True.
- HTMLExporter.exclude_unknownBool
Default:
False
This allows you to exclude unknown cells from all templates if set to True.
- HTMLExporter.extra_template_basedirsList
Default:
[]
No description
- HTMLExporter.extra_template_pathsList
Default:
[]
No description
- HTMLExporter.file_extensionFilenameExtension
Default:
''
Extension of the file that should be written to disk
- HTMLExporter.filtersDict
Default:
{}
- Dictionary of filters, by name and namespace, to add to the Jinja
environment.
- HTMLExporter.html_manager_semver_rangeUnicode
Default:
'*'
Semver range for Jupyter widgets HTML manager
- HTMLExporter.jquery_urlUnicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.3/jquery.m...
URL to load jQuery from.
Defaults to loading from cdnjs.
- HTMLExporter.jupyter_widgets_base_urlUnicode
Default:
'https://unpkg.com/'
URL base for Jupyter widgets
- HTMLExporter.language_codeUnicode
Default:
'en'
Language code of the content, should be one of the ISO639-1
- HTMLExporter.mathjax_urlUnicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest....
URL to load Mathjax from.
Defaults to loading from cdnjs.
- HTMLExporter.optimistic_validationBool
Default:
False
Reduces the number of validation steps so that it only occurs after all preprocesors have run.
- HTMLExporter.preprocessorsList
Default:
[]
List of preprocessors, by name or namespace, to enable.
- HTMLExporter.raw_mimetypesList
Default:
[]
formats of raw cells to be included in this Exporter’s output.
- HTMLExporter.require_js_urlUnicode
Default:
'https://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.10/req...
URL to load require.js from.
Defaults to loading from cdnjs.
- HTMLExporter.sanitize_htmlBool
Default:
False
Whether the HTML in Markdown cells and cell outputs should be sanitized.This should be set to True by nbviewer or similar tools.
- HTMLExporter.skip_svg_encodingBool
Default:
False
Whether the svg to image data attribute encoding should occur
- HTMLExporter.template_extensionUnicode
Default:
''
No description
- HTMLExporter.template_fileUnicode
Default:
None
Name of the template file to use
- HTMLExporter.template_nameUnicode
Default:
''
Name of the template to use
- HTMLExporter.template_pathsList
Default:
['.']
No description
- HTMLExporter.themeUnicode
Default:
'light'
Template specific theme(e.g. the name of a JupyterLab CSS theme distributed as prebuilt extension for the lab template)
- HTMLExporter.widget_renderer_urlUnicode
Default:
''
Full URL for Jupyter widgets