potluck.default_config

 1BASE_DIR = "."
 2"""
 3Base directory to use to look for things like task info, task specs, and
 4submitted files.
 5"""
 6
 7TEMPLATES_DIRECTORY = None
 8"""
 9Templates directory for Jinja2 templates. If it's not an absolute path,
10it will be relative to the potluck package directory. If left as None,
11templates will be loaded from the 'templates' directory in the 'potluck'
12package (wherever that's installed).
13"""
14
15RESOURCES_DIRECTORY = None
16"""
17Resources directory for css and js files. If it's not an absolute path,
18it will be relative to the potluck package directory. If left as None,
19CSS and JS files will be loaded from the 'resources' directory in the
20'potluck' package (wherever that's installed).
21"""
22
23TASKS_FILENAME = "tasks.json"
24"""
25The file name of the tasks meta-data file, relative to BASE_DIR. May be
26an absolute path instead.
27"""
28
29SUBMISSIONS_DIR = "submissions"
30"""
31Directory to find submissions in, relative to BASE_DIR (or not, if an
32absolute path is provided). The submissions directory must have a
33directory for each username, within which must be directories for each
34submitted task named by the task ID. Submitted files for each task should
35be placed in these task directories.
36"""
37
38EXAMPLES_DIR = "examples"
39"""
40Directory to find example submissions in. These submissions are used
41along with expectations established by specifications modules to check to
42make sure that specifications are working. May be the same as
43`SUBMISSIONS_DIR` if you're sure that real users won't ever share the
44same username as your example submissions (hard to be sure of this...).
45"""
46
47REPORTS_DIR = "reports"
48"""
49Directory to write reports into, relative to BASE_DIR (or not, if an
50absolute path is provided). Per-user sub-directories will be created,
51where timestamped reports will be written.
52"""
53
54RUBRICS_DIRECTORY = "rubrics"
55"""
56Directory to write blank rubrics into, relative to BASE_DIR (or not, if
57an absolute path is provided).
58"""
59
60SNIPPETS_DIRECTORY = "snippets"
61"""
62Directory where snippets should be written. Subdirectories for each task
63will be created, and snippet files will be created within those. Relative
64to BASE_DIR, unless an absolute path is provided.
65"""
66
67INSTRUCTIONS_DIRECTORY = "instructions"
68"""
69Directory where instructions files should be stored. A folder for each
70task's instructions will be created in this directory, with a
71instructions file and resources directory within it. Relative to
72BASE_DIR, unless an absolute path is provided.
73"""
74
75INSTRUCTION_RESOURCES_DIRNAME = "resources"
76"""
77The name for instructions-resources directories, to be found in the
78specifications directory and copied into the generated instructions
79directories. This must be just a directory name, not a path.
80"""
81
82SHELF_FILE = "reference_values.shelf"
83"""
84The filename (relative to the base directory unless it's absolute) for
85storing cached reference values using the `shelve` module.
86TODO: Use this!
87"""
88
89LOCALE = "en_US.utf-8"
90"""
91The locale to set when `potluck.control.setup` is called. Most
92importantly, this affects the default encoding used by open() calls, in
93both solution and submitted code. This value is set as the LC_ALL value
94using `locale.setlocale`.
95"""