-
Notifications
You must be signed in to change notification settings - Fork 151
/
nbgrader_config.py
1744 lines (1398 loc) · 71.1 KB
/
nbgrader_config.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Configuration file for nbgrader-generate-config.
c = get_config() #noqa
#------------------------------------------------------------------------------
# Application(SingletonConfigurable) configuration
#------------------------------------------------------------------------------
## This is an application.
## The date format used by logging formatters for %(asctime)s
# Default: '%Y-%m-%d %H:%M:%S'
# c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S'
## The Logging format template
# Default: '[%(name)s]%(highlevel)s %(message)s'
# c.Application.log_format = '[%(name)s]%(highlevel)s %(message)s'
## Set the log level by value or name.
# Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
# Default: 30
# c.Application.log_level = 30
## 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 formatter ``console``.
# * A logger with the name of this application set to ``DEBUG``
# level.
#
# This example adds a new handler that writes to a file:
#
# .. code-block:: python
#
# 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"],
# },
# },
# }
# Default: {}
# c.Application.logging_config = {}
## Instead of starting the Application, dump configuration to stdout
# Default: False
# c.Application.show_config = False
## Instead of starting the Application, dump configuration to stdout (as JSON)
# Default: False
# c.Application.show_config_json = False
#------------------------------------------------------------------------------
# JupyterApp(Application) configuration
#------------------------------------------------------------------------------
## Base class for Jupyter applications
## Answer yes to any prompts.
# Default: False
# c.JupyterApp.answer_yes = False
## Full path of a config file.
# Default: ''
# c.JupyterApp.config_file = ''
## Specify a config file to load.
# Default: ''
# c.JupyterApp.config_file_name = ''
## Generate default config file.
# Default: False
# c.JupyterApp.generate_config = False
## The date format used by logging formatters for %(asctime)s
# See also: Application.log_datefmt
# c.JupyterApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
## The Logging format template
# See also: Application.log_format
# c.JupyterApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
## Set the log level by value or name.
# See also: Application.log_level
# c.JupyterApp.log_level = 30
##
# See also: Application.logging_config
# c.JupyterApp.logging_config = {}
## Instead of starting the Application, dump configuration to stdout
# See also: Application.show_config
# c.JupyterApp.show_config = False
## Instead of starting the Application, dump configuration to stdout (as JSON)
# See also: Application.show_config_json
# c.JupyterApp.show_config_json = False
#------------------------------------------------------------------------------
# NbGrader(JupyterApp) configuration
#------------------------------------------------------------------------------
## A base class for all the nbgrader apps.
## Answer yes to any prompts.
# See also: JupyterApp.answer_yes
# c.NbGrader.answer_yes = False
## Full path of a config file.
# See also: JupyterApp.config_file
# c.NbGrader.config_file = ''
## Specify a config file to load.
# See also: JupyterApp.config_file_name
# c.NbGrader.config_file_name = ''
## Generate default config file.
# See also: JupyterApp.generate_config
# c.NbGrader.generate_config = False
## The date format used by logging formatters for %(asctime)s
# See also: Application.log_datefmt
# c.NbGrader.log_datefmt = '%Y-%m-%d %H:%M:%S'
## The Logging format template
# See also: Application.log_format
# c.NbGrader.log_format = '[%(name)s]%(highlevel)s %(message)s'
## Set the log level by value or name.
# See also: Application.log_level
# c.NbGrader.log_level = 30
## Name of the logfile to log to. By default, log output is not written to any
# file.
# Default: ''
# c.NbGrader.logfile = ''
##
# See also: Application.logging_config
# c.NbGrader.logging_config = {}
## Instead of starting the Application, dump configuration to stdout
# See also: Application.show_config
# c.NbGrader.show_config = False
## Instead of starting the Application, dump configuration to stdout (as JSON)
# See also: Application.show_config_json
# c.NbGrader.show_config_json = False
#------------------------------------------------------------------------------
# GenerateConfigApp(NbGrader) configuration
#------------------------------------------------------------------------------
## Answer yes to any prompts.
# See also: JupyterApp.answer_yes
# c.GenerateConfigApp.answer_yes = False
## Full path of a config file.
# See also: JupyterApp.config_file
# c.GenerateConfigApp.config_file = ''
## Specify a config file to load.
# See also: JupyterApp.config_file_name
# c.GenerateConfigApp.config_file_name = ''
## The name of the configuration file to generate.
# Default: 'nbgrader_config.py'
# c.GenerateConfigApp.filename = 'nbgrader_config.py'
## Generate default config file.
# See also: JupyterApp.generate_config
# c.GenerateConfigApp.generate_config = False
## The date format used by logging formatters for %(asctime)s
# See also: Application.log_datefmt
# c.GenerateConfigApp.log_datefmt = '%Y-%m-%d %H:%M:%S'
## The Logging format template
# See also: Application.log_format
# c.GenerateConfigApp.log_format = '[%(name)s]%(highlevel)s %(message)s'
## Set the log level by value or name.
# See also: Application.log_level
# c.GenerateConfigApp.log_level = 30
##
# See also: NbGrader.logfile
# c.GenerateConfigApp.logfile = ''
##
# See also: Application.logging_config
# c.GenerateConfigApp.logging_config = {}
## Instead of starting the Application, dump configuration to stdout
# See also: Application.show_config
# c.GenerateConfigApp.show_config = False
## Instead of starting the Application, dump configuration to stdout (as JSON)
# See also: Application.show_config_json
# c.GenerateConfigApp.show_config_json = False
#------------------------------------------------------------------------------
# ExchangeFactory(LoggingConfigurable) configuration
#------------------------------------------------------------------------------
## A plugin for collecting assignments.
# Default: 'nbgrader.exchange.default.collect.ExchangeCollect'
# c.ExchangeFactory.collect = 'nbgrader.exchange.default.collect.ExchangeCollect'
## A plugin for exchange.
# Default: 'nbgrader.exchange.default.exchange.Exchange'
# c.ExchangeFactory.exchange = 'nbgrader.exchange.default.exchange.Exchange'
## A plugin for fetching assignments.
# Default: 'nbgrader.exchange.default.fetch_assignment.ExchangeFetchAssignment'
# c.ExchangeFactory.fetch_assignment = 'nbgrader.exchange.default.fetch_assignment.ExchangeFetchAssignment'
## A plugin for fetching feedback.
# Default: 'nbgrader.exchange.default.fetch_feedback.ExchangeFetchFeedback'
# c.ExchangeFactory.fetch_feedback = 'nbgrader.exchange.default.fetch_feedback.ExchangeFetchFeedback'
## A plugin for listing exchange files.
# Default: 'nbgrader.exchange.default.list.ExchangeList'
# c.ExchangeFactory.list = 'nbgrader.exchange.default.list.ExchangeList'
## A plugin for releasing assignments.
# Default: 'nbgrader.exchange.default.release_assignment.ExchangeReleaseAssignment'
# c.ExchangeFactory.release_assignment = 'nbgrader.exchange.default.release_assignment.ExchangeReleaseAssignment'
## A plugin for releasing feedback.
# Default: 'nbgrader.exchange.default.release_feedback.ExchangeReleaseFeedback'
# c.ExchangeFactory.release_feedback = 'nbgrader.exchange.default.release_feedback.ExchangeReleaseFeedback'
## A plugin for submitting assignments.
# Default: 'nbgrader.exchange.default.submit.ExchangeSubmit'
# c.ExchangeFactory.submit = 'nbgrader.exchange.default.submit.ExchangeSubmit'
#------------------------------------------------------------------------------
# CourseDirectory(LoggingConfigurable) configuration
#------------------------------------------------------------------------------
## 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.
# Default: ''
# c.CourseDirectory.assignment_id = ''
## 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.
# Default: 'autograded'
# c.CourseDirectory.autograded_directory = 'autograded'
## 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.
# Default: ''
# c.CourseDirectory.course_id = ''
## URL to the database. Defaults to sqlite:///<root>/gradebook.db, where <root>
# is another configurable variable.
# Default: ''
# c.CourseDirectory.db_url = ''
## 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.
# Default: '{nbgrader_step}/{student_id}/{assignment_id}'
# c.CourseDirectory.directory_structure = '{nbgrader_step}/{student_id}/{assignment_id}'
## 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.
# Default: 'feedback'
# c.CourseDirectory.feedback_directory = 'feedback'
## 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.
# Default: False
# c.CourseDirectory.groupshared = False
## List of file names or file globs. Upon copying directories recursively,
# matching files and directories will be ignored with a debug message.
# Default: ['.ipynb_checkpoints', '*.pyc', '__pycache__', 'feedback']
# c.CourseDirectory.ignore = ['.ipynb_checkpoints', '*.pyc', '__pycache__', 'feedback']
## List of file names or file globs. Upon copying directories recursively, non
# matching files will be ignored with a debug message.
# Default: ['*']
# c.CourseDirectory.include = ['*']
## Maximum size of directories (in kilobytes; default: 100Mb). Upon copying
# directories recursively, larger files will be ignored with a warning.
# Default: 100000
# c.CourseDirectory.max_dir_size = 100000
## Maximum size of files (in kilobytes; default: 100Mb). Upon copying directories
# recursively, larger files will be ignored with a warning.
# Default: 100000
# c.CourseDirectory.max_file_size = 100000
## File glob to match notebook names, excluding the '.ipynb' extension. This can
# be changed to filter by notebook.
# Default: '*'
# c.CourseDirectory.notebook_id = '*'
## 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.
# Default: 'release'
# c.CourseDirectory.release_directory = 'release'
## The root directory for the course files (that includes the `source`,
# `release`, `submitted`, `autograded`, etc. directories). Defaults to the
# current working directory.
# Default: ''
# c.CourseDirectory.root = ''
## 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.
# Default: 'solution'
# c.CourseDirectory.solution_directory = 'solution'
## 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.
# Default: 'source'
# c.CourseDirectory.source_directory = 'source'
## 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.
# Default: 'source_with_tests'
# c.CourseDirectory.source_with_tests_directory = 'source_with_tests'
## 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:
#
# https://github.com/jupyter/nbgrader/issues/743
#
# for more details.
# Default: '*'
# c.CourseDirectory.student_id = '*'
## 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.
# Default: ''
# c.CourseDirectory.student_id_exclude = ''
## 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.
# Default: 'submitted'
# c.CourseDirectory.submitted_directory = 'submitted'
#------------------------------------------------------------------------------
# Authenticator(LoggingConfigurable) configuration
#------------------------------------------------------------------------------
## A plugin for different authentication methods.
# Default: 'nbgrader.auth.base.NoAuthPlugin'
# c.Authenticator.plugin_class = 'nbgrader.auth.base.NoAuthPlugin'
#------------------------------------------------------------------------------
# ExportPlugin(BasePlugin) configuration
#------------------------------------------------------------------------------
## Base class for export plugins.
## list of assignments to export
# Default: []
# c.ExportPlugin.assignment = []
## list of students to export
# Default: []
# c.ExportPlugin.student = []
## destination to export to
# Default: ''
# c.ExportPlugin.to = ''
#------------------------------------------------------------------------------
# CsvExportPlugin(ExportPlugin) configuration
#------------------------------------------------------------------------------
## CSV exporter plugin.
## list of assignments to export
# See also: ExportPlugin.assignment
# c.CsvExportPlugin.assignment = []
## list of students to export
# See also: ExportPlugin.student
# c.CsvExportPlugin.student = []
## destination to export to
# See also: ExportPlugin.to
# c.CsvExportPlugin.to = ''
#------------------------------------------------------------------------------
# ExtractorPlugin(BasePlugin) configuration
#------------------------------------------------------------------------------
## Submission archive files extractor plugin for the
# :class:`~nbgrader.apps.zipcollectapp.ZipCollectApp`.
# Extractor plugin subclasses MUST inherit from this class.
## Force overwrite of existing files.
# Default: False
# c.ExtractorPlugin.force = False
## 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`.
# Default: ['.zip', '.gz']
# c.ExtractorPlugin.zip_ext = ['.zip', '.gz']
#------------------------------------------------------------------------------
# FileNameCollectorPlugin(BasePlugin) configuration
#------------------------------------------------------------------------------
## Submission filename collector plugin for the
# :class:`~nbgrader.apps.zipcollectapp.ZipCollectApp`.
# Collect plugin subclasses MUST inherit from this class.
## 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
# Default: ''
# c.FileNameCollectorPlugin.named_regexp = ''
## List of valid submission filename extensions to collect. Any submitted file
# with an extension not in this list is skipped.
# Default: ['.ipynb']
# c.FileNameCollectorPlugin.valid_ext = ['.ipynb']
#------------------------------------------------------------------------------
# LateSubmissionPlugin(BasePlugin) configuration
#------------------------------------------------------------------------------
## Predefined methods for assigning penalties for late submission
## The method for assigning late submission penalties:
# 'none': do nothing (no penalty assigned)
# 'zero': assign an overall score of zero (penalty = score)
# Choices: any of ['none', 'zero']
# Default: 'none'
# c.LateSubmissionPlugin.penalty_method = 'none'
#------------------------------------------------------------------------------
# NbConvertBase(LoggingConfigurable) configuration
#------------------------------------------------------------------------------
## Global configurable class for shared config
#
# Useful for display data priority that might be used by many transformers
## Deprecated default highlight language as of 5.0, please use language_info
# metadata instead
# Default: 'ipython'
# c.NbConvertBase.default_language = 'ipython'
## An ordered list of preferred output type, the first encountered will usually
# be used when converting discarding the others.
# Default: ['text/html', 'application/pdf', 'text/latex', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/markdown', 'text/plain']
# c.NbConvertBase.display_data_priority = ['text/html', 'application/pdf', 'text/latex', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/markdown', 'text/plain']
#------------------------------------------------------------------------------
# Preprocessor(NbConvertBase) configuration
#------------------------------------------------------------------------------
## A configurable preprocessor
#
# Inherit from this class if you wish to have configurability for your
# preprocessor.
#
# Any configurable traitlets this class exposed will be configurable in
# profiles using c.SubClassName.attribute = value
#
# You can overwrite `preprocess_cell()` to apply a transformation
# independently on each cell or `preprocess()` if you prefer your own
# logic. See corresponding docstring for information.
#
# Disabled by default and can be enabled via the config by
# 'c.YourPreprocessorName.enabled = True'
## Deprecated default highlight language as of 5.0, please use language_info
# metadata instead
# See also: NbConvertBase.default_language
# c.Preprocessor.default_language = 'ipython'
##
# See also: NbConvertBase.display_data_priority
# c.Preprocessor.display_data_priority = ['text/html', 'application/pdf', 'text/latex', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/markdown', 'text/plain']
# Default: False
# c.Preprocessor.enabled = False
#------------------------------------------------------------------------------
# NbGraderPreprocessor(Preprocessor) configuration
#------------------------------------------------------------------------------
## Whether to use this preprocessor when running nbgrader
# Default: True
# c.NbGraderPreprocessor.enabled = True
#------------------------------------------------------------------------------
# AssignLatePenalties(NbGraderPreprocessor) configuration
#------------------------------------------------------------------------------
## Preprocessor for assigning penalties for late submissions to the database
## Whether to use this preprocessor when running nbgrader
# See also: NbGraderPreprocessor.enabled
# c.AssignLatePenalties.enabled = True
## The plugin class for assigning the late penalty for each notebook.
# Default: 'nbgrader.plugins.latesubmission.LateSubmissionPlugin'
# c.AssignLatePenalties.plugin_class = 'nbgrader.plugins.latesubmission.LateSubmissionPlugin'
#------------------------------------------------------------------------------
# IncludeHeaderFooter(NbGraderPreprocessor) configuration
#------------------------------------------------------------------------------
## A preprocessor for adding header and/or footer cells to a notebook.
## Whether to use this preprocessor when running nbgrader
# See also: NbGraderPreprocessor.enabled
# c.IncludeHeaderFooter.enabled = True
## Path to footer notebook, relative to the root of the course directory
# Default: ''
# c.IncludeHeaderFooter.footer = ''
## Path to header notebook, relative to the root of the course directory
# Default: ''
# c.IncludeHeaderFooter.header = ''
#------------------------------------------------------------------------------
# LockCells(NbGraderPreprocessor) configuration
#------------------------------------------------------------------------------
## A preprocessor for making cells undeletable.
## Whether to use this preprocessor when running nbgrader
# See also: NbGraderPreprocessor.enabled
# c.LockCells.enabled = True
## Whether all assignment cells are locked (non-deletable and non-editable)
# Default: False
# c.LockCells.lock_all_cells = False
## Whether grade cells are locked (non-deletable)
# Default: True
# c.LockCells.lock_grade_cells = True
## Whether readonly cells are locked (non-deletable and non-editable)
# Default: True
# c.LockCells.lock_readonly_cells = True
## Whether solution cells are locked (non-deletable and non-editable)
# Default: True
# c.LockCells.lock_solution_cells = True
#------------------------------------------------------------------------------
# ClearSolutions(NbGraderPreprocessor) configuration
#------------------------------------------------------------------------------
## The delimiter marking the beginning of a solution
# Default: 'BEGIN SOLUTION'
# c.ClearSolutions.begin_solution_delimeter = 'BEGIN SOLUTION'
## The code snippet that will replace code solutions
# Default: {'python': '# YOUR CODE HERE\nraise NotImplementedError()', 'R': '# YOUR CODE HERE\nfail()', 'matlab': "% YOUR CODE HERE\nerror('No Answer Given!')", 'octave': "% YOUR CODE HERE\nerror('No Answer Given!')", 'sas': '/* YOUR CODE HERE */\n %notImplemented;', 'java': '// YOUR CODE HERE'}
# c.ClearSolutions.code_stub = {'python': '# YOUR CODE HERE\nraise NotImplementedError()', 'R': '# YOUR CODE HERE\nfail()', 'matlab': "% YOUR CODE HERE\nerror('No Answer Given!')", 'octave': "% YOUR CODE HERE\nerror('No Answer Given!')", 'sas': '/* YOUR CODE HERE */\n %notImplemented;', 'java': '// YOUR CODE HERE'}
c.ClearSolutions.code_stub = {
"python": "YOUR-CODE-HERE",
}
## Whether to use this preprocessor when running nbgrader
# See also: NbGraderPreprocessor.enabled
# c.ClearSolutions.enabled = True
## The delimiter marking the end of a solution
# Default: 'END SOLUTION'
# c.ClearSolutions.end_solution_delimeter = 'END SOLUTION'
## 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.
# Default: True
# c.ClearSolutions.enforce_metadata = True
## The text snippet that will replace written solutions
# Default: 'YOUR ANSWER HERE'
# c.ClearSolutions.text_stub = 'YOUR ANSWER HERE'
#------------------------------------------------------------------------------
# SaveAutoGrades(NbGraderPreprocessor) configuration
#------------------------------------------------------------------------------
## Preprocessor for saving out the autograder grades into a database
## Whether to use this preprocessor when running nbgrader
# See also: NbGraderPreprocessor.enabled
# c.SaveAutoGrades.enabled = True
#------------------------------------------------------------------------------
# ComputeChecksums(NbGraderPreprocessor) configuration
#------------------------------------------------------------------------------
## A preprocessor to compute checksums of grade cells.
## Whether to use this preprocessor when running nbgrader
# See also: NbGraderPreprocessor.enabled
# c.ComputeChecksums.enabled = True
#------------------------------------------------------------------------------
# SaveCells(NbGraderPreprocessor) configuration
#------------------------------------------------------------------------------
## A preprocessor to save information about grade and solution cells.
## Whether to use this preprocessor when running nbgrader
# See also: NbGraderPreprocessor.enabled
# c.SaveCells.enabled = True
#------------------------------------------------------------------------------
# OverwriteCells(NbGraderPreprocessor) configuration
#------------------------------------------------------------------------------
## A preprocessor to overwrite information about grade and solution cells.
## Whether or not missing grade_cells should be added back to the notebooks being
# graded.
# Default: False
# c.OverwriteCells.add_missing_cells = False
## Whether to use this preprocessor when running nbgrader
# See also: NbGraderPreprocessor.enabled
# c.OverwriteCells.enabled = True
## A text to add at the beginning of every missing cell re-added to the notebook
# during autograding.
# Default: 'This cell (id:{cell_id}) was missing from the submission. It was added back by nbgrader.\n\n'
# c.OverwriteCells.missing_cell_notification = 'This cell (id:{cell_id}) was missing from the submission. It was added back by nbgrader.\n\n'
#------------------------------------------------------------------------------
# CheckCellMetadata(NbGraderPreprocessor) configuration
#------------------------------------------------------------------------------
## A preprocessor for checking that grade ids are unique.
## Whether to use this preprocessor when running nbgrader
# See also: NbGraderPreprocessor.enabled
# c.CheckCellMetadata.enabled = True
#------------------------------------------------------------------------------
# NotebookClient(LoggingConfigurable) configuration
#------------------------------------------------------------------------------
## Encompasses a Client for executing cells in a notebook
## 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.
# Default: []
# c.NotebookClient.allow_error_names = []
## If ``False`` (default), when a cell raises an error the execution is stopped
# and a ``CellExecutionError`` is raised, except if the error name is in
# ``allow_error_names``. If ``True``, 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.
# Default: False
# c.NotebookClient.allow_errors = False
## An ordered list of preferred output type, the first encountered will usually
# be used when converting discarding the others.
# Default: ['text/html', 'application/pdf', 'text/latex', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/markdown', 'text/plain']
# c.NotebookClient.display_data_priority = ['text/html', 'application/pdf', 'text/latex', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/markdown', 'text/plain']
## 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
# }
# Default: None
# c.NotebookClient.error_on_timeout = None
# Default: []
# c.NotebookClient.extra_arguments = []
## If False (default), errors from executing the notebook can be allowed with a
# ``raises-exception`` tag on a single cell, or the ``allow_errors`` or
# ``allow_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, a ``CellExecutionError`` will be
# raised. If True, ``CellExecutionError`` will be raised for any error that
# occurs while executing the notebook. This overrides the ``allow_errors`` and
# ``allow_error_names`` options and the ``raises-exception`` cell tag.
# Default: False
# c.NotebookClient.force_raise_errors = False
## If execution of a cell times out, interrupt the kernel and continue executing
# other cells rather than throwing an error and stopping.
# Default: False
# c.NotebookClient.interrupt_on_timeout = False
## 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.
# Default: 4
# c.NotebookClient.iopub_timeout = 4
## 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.
# Default: ':memory:'
# c.NotebookClient.ipython_hist_file = ':memory:'
## The kernel manager class to use.
# Default: 'jupyter_client.manager.KernelManager'
# c.NotebookClient.kernel_manager_class = 'jupyter_client.manager.KernelManager'
## Name of kernel to use to execute the cells. If not set, use the kernel_spec
# embedded in the notebook.
# Default: ''
# c.NotebookClient.kernel_name = ''
## 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`` and
# ``cell_index``.
# Default: None
# c.NotebookClient.on_cell_complete = 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 kwargs ``cell`, ``cell_index`` and ``execute_reply``.
# Default: None
# c.NotebookClient.on_cell_error = None
## A callable which executes just before a code cell is executed. Called with
# kwargs ``cell`` and ``cell_index``.
# Default: None
# c.NotebookClient.on_cell_execute = 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`` and
# ``execute_reply``.
# Default: None
# c.NotebookClient.on_cell_executed = None
## A callable which executes before a cell is executed and before non-executing
# cells are skipped. Called with kwargs ``cell`` and ``cell_index``.
# Default: None
# c.NotebookClient.on_cell_start = None
## A callable which executes after the kernel is cleaned up. Called with kwargs
# ``notebook``.
# Default: None
# c.NotebookClient.on_notebook_complete = None
## A callable which executes when the notebook encounters an error. Called with
# kwargs ``notebook``.
# Default: None
# c.NotebookClient.on_notebook_error = None
## A callable which executes after the kernel manager and kernel client are
# setup, and cells are about to execute. Called with kwargs ``notebook``.
# Default: None
# c.NotebookClient.on_notebook_start = None
## 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. If ``True``, 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.
# Default: False
# c.NotebookClient.raise_on_iopub_timeout = False
## If ``True`` (default), then the execution timings of each cell will be stored
# in the metadata of the notebook.
# Default: True
# c.NotebookClient.record_timing = True
## 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.
# Default: 5
# c.NotebookClient.shell_timeout_interval = 5
## If ``graceful`` (default), then the kernel is given time to clean up after
# executing all cells, e.g., to execute its ``atexit`` hooks. If ``immediate``,
# then the kernel is signaled to immediately terminate.
# Choices: any of ['graceful', 'immediate']
# Default: 'graceful'
# c.NotebookClient.shutdown_kernel = 'graceful'
## Name of the cell tag to use to denote a cell that should be skipped.
# Default: 'skip-execution'
# c.NotebookClient.skip_cells_with_tag = 'skip-execution'
## The time to wait (in seconds) for the kernel to start. If kernel startup takes
# longer, a RuntimeError is raised.
# Default: 60
# c.NotebookClient.startup_timeout = 60
## If ``True`` (default), then the state of the Jupyter widgets created at the
# kernel will be stored in the metadata of the notebook.
# Default: True
# c.NotebookClient.store_widget_state = True
## 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. If ``timeout_func`` is set, it
# overrides ``timeout``.
# Default: None
# c.NotebookClient.timeout = 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
# setting ``timeout_func`` will cause the client to default to using the
# ``timeout`` trait for all cells. The ``timeout_func`` trait overrides
# ``timeout`` if it is not ``None``.
# Default: None
# c.NotebookClient.timeout_func = None
#------------------------------------------------------------------------------
# ExecutePreprocessor(Preprocessor, NotebookClient) configuration
#------------------------------------------------------------------------------
## Executes all the cells in a notebook
##
# See also: NotebookClient.allow_error_names
# c.ExecutePreprocessor.allow_error_names = []
##
# See also: NotebookClient.allow_errors
# c.ExecutePreprocessor.allow_errors = False
## Deprecated default highlight language as of 5.0, please use language_info
# metadata instead
# See also: NbConvertBase.default_language
# c.ExecutePreprocessor.default_language = 'ipython'
##
# See also: NbConvertBase.display_data_priority
# c.ExecutePreprocessor.display_data_priority = ['text/html', 'application/pdf', 'text/latex', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/markdown', 'text/plain']
# See also: Preprocessor.enabled
# c.ExecutePreprocessor.enabled = False
##
# See also: NotebookClient.error_on_timeout
# c.ExecutePreprocessor.error_on_timeout = None
# See also: NotebookClient.extra_arguments
# c.ExecutePreprocessor.extra_arguments = []
##
# See also: NotebookClient.force_raise_errors
# c.ExecutePreprocessor.force_raise_errors = False
##
# See also: NotebookClient.interrupt_on_timeout
# c.ExecutePreprocessor.interrupt_on_timeout = False
##
# See also: NotebookClient.iopub_timeout
# c.ExecutePreprocessor.iopub_timeout = 4
## Path to file to use for SQLite history database for an IPython kernel.
# See also: NotebookClient.ipython_hist_file
# c.ExecutePreprocessor.ipython_hist_file = ':memory:'
## The kernel manager class to use.
# See also: NotebookClient.kernel_manager_class
# c.ExecutePreprocessor.kernel_manager_class = 'jupyter_client.manager.KernelManager'
##
# See also: NotebookClient.kernel_name
# c.ExecutePreprocessor.kernel_name = ''
##
# See also: NotebookClient.on_cell_complete
# c.ExecutePreprocessor.on_cell_complete = None
##
# See also: NotebookClient.on_cell_error
# c.ExecutePreprocessor.on_cell_error = None
##
# See also: NotebookClient.on_cell_execute
# c.ExecutePreprocessor.on_cell_execute = None
##
# See also: NotebookClient.on_cell_executed
# c.ExecutePreprocessor.on_cell_executed = None
##
# See also: NotebookClient.on_cell_start
# c.ExecutePreprocessor.on_cell_start = None
##
# See also: NotebookClient.on_notebook_complete
# c.ExecutePreprocessor.on_notebook_complete = None
##
# See also: NotebookClient.on_notebook_error
# c.ExecutePreprocessor.on_notebook_error = None
##
# See also: NotebookClient.on_notebook_start
# c.ExecutePreprocessor.on_notebook_start = None
##
# See also: NotebookClient.raise_on_iopub_timeout
# c.ExecutePreprocessor.raise_on_iopub_timeout = False
##
# See also: NotebookClient.record_timing
# c.ExecutePreprocessor.record_timing = True
##
# See also: NotebookClient.shell_timeout_interval
# c.ExecutePreprocessor.shell_timeout_interval = 5
##
# See also: NotebookClient.shutdown_kernel
# c.ExecutePreprocessor.shutdown_kernel = 'graceful'
##
# See also: NotebookClient.skip_cells_with_tag
# c.ExecutePreprocessor.skip_cells_with_tag = 'skip-execution'
##
# See also: NotebookClient.startup_timeout
# c.ExecutePreprocessor.startup_timeout = 60
##
# See also: NotebookClient.store_widget_state
# c.ExecutePreprocessor.store_widget_state = True
##
# See also: NotebookClient.timeout
# c.ExecutePreprocessor.timeout = None
##
# See also: NotebookClient.timeout_func
# c.ExecutePreprocessor.timeout_func = None
#------------------------------------------------------------------------------