Index

A

ANSWER_ID_DELIMITERS (logbookgenerator.config.constants.Constants attribute)

ANSWER_KEYWORD (logbookgenerator.config.constants.Constants attribute)

B

BLOCK_COMMENT_MIDDLE (logbookgenerator.config.constants.Constants attribute)

BLOCK_COMMENT_START (logbookgenerator.config.constants.Constants attribute) build_config_file() (in module logbookgenerator.computation.config_generation)

C

cleanup_temporary_files() (in module logbookgenerator.config.paths) CODE_COMMENT_DELIMITER (logbookgenerator.config.constants.Constants attribute) command_line_interface() (in module logbookgenerator.interface.command_line) COMMENT_END (logbookgenerator.config.constants.Constants attribute)

Constants (class in logbookgenerator.config.constants) COURSEWORK_REGEX (logbookgenerator.config.constants.Constants attribute) create_clean_code_files() (in module logbookgenerator.utilities.file_handling) create_coursework() (in module logbookgenerator.computation.render_context) create_logbook() (in module logbookgenerator.computation.render_context)

D

DATE_DATETIME_FORMAT (logbookgenerator.config.constants.Constants attribute) DATE_REGEX_FORMAT (logbookgenerator.config.constants.Constants attribute) DEFAULT_CONFIG_FILE (logbookgenerator.config.constants.Constants attribute) DEFAULT_INPUT_DIRECTORY (logbookgenerator.config.constants.Constants attribute) DEFAULT_LOG_SAVE_PATH (logbookgenerator.config.constants.Constants attribute)

DEFAULT_MODULE_CODE (logbookgenerator.config.constants.Constants attribute) DEFAULT_MODULE_NAME (logbookgenerator.config.constants.Constants attribute) DEFAULT_OUTPUT_FILE (logbookgenerator.config.constants.Constants attribute) DEFAULT_STATEMENT_TEXT (logbookgenerator.config.constants.Constants attribute) DEFAULT_UNIVERSITY_DEPARTMENT (logbookgenerator.config.constants.Constants attribute) DEFAULT_UNIVERSITY_NAME (logbookgenerator.config.constants.Constants attribute)

E

extract_block_comment() (in module logbookgenerator.computation.comment_extraction) extract_comment_code() (in module logbookgenerator.computation.comment_extraction)

extract_comment_content() (in module logbookgenerator.computation.comment_extraction) extract_comment_id() (in module logbookgenerator.computation.comment_extraction)

F

FORBIDDEN_CODE (logbookgenerator.config.constants.Constants attribute)

G

generate_coursework_context() (in module logbookgenerator.computation.context_generation) generate_logbook_contexts() (in module logbookgenerator.computation.context_generation)

generate_tasks_context() (in module logbookgenerator.computation.context_generation) generate_week_context() (in module logbookgenerator.computation.context_generation) generate_weeks_context() (in module logbookgenerator.computation.context_generation)

I

ID_REGEX_FORMAT (logbookgenerator.config.constants.Constants attribute)

INLINE_ANSWER_COMMENT (logbookgenerator.config.constants.Constants attribute) INLINE_COMMENT_START (logbookgenerator.config.constants.Constants attribute)

J

JINJA_DATE_FORMAT (logbookgenerator.config.constants.Constants attribute)

L

load_yaml() (in module logbookgenerator.utilities.file_handling) logbookgenerator module logbookgenerator.computation module logbookgenerator.computation.code_processing module logbookgenerator.computation.comment_extraction module logbookgenerator.computation.config_generation module logbookgenerator.computation.context_generation module logbookgenerator.computation.parsing module logbookgenerator.computation.render_context module logbookgenerator.config module logbookgenerator.config.constants module logbookgenerator.config.paths module logbookgenerator.integrations module

logbookgenerator.interface module logbookgenerator.interface.command_line module logbookgenerator.logs module logbookgenerator.logs.setup_logging module logbookgenerator.main module logbookgenerator.utilities module logbookgenerator.utilities.file_handling module logbookgenerator.utilities.validation module LOGGING_CONSOLE_FORMAT (logbookgenerator.config.constants.Constants attribute) LOGGING_DATE_FORMAT (logbookgenerator.config.constants.Constants attribute) LOGGING_LEVEL_CONSOLE_DEFAULT (logbookgenerator.config.constants.Constants attribute) LOGGING_LEVEL_LOGFILE_DEFAULT (logbookgenerator.config.constants.Constants attribute) LOGGING_LOGFILE_FORMAT (logbookgenerator.config.constants.Constants attribute) LOGGING_TIMESTAMP_FORMAT (logbookgenerator.config.constants.Constants attribute) LOGGING_TRACEBACKS (logbookgenerator.config.constants.Constants attribute)

M

main() (in module logbookgenerator.main) module logbookgenerator logbookgenerator.computation logbookgenerator.computation.code_processing logbookgenerator.computation.comment_extraction logbookgenerator.computation.config_generation logbookgenerator.computation.context_generation logbookgenerator.computation.parsing logbookgenerator.computation.render_context logbookgenerator.config logbookgenerator.config.constants logbookgenerator.config.paths logbookgenerator.integrations logbookgenerator.interface logbookgenerator.interface.command_line logbookgenerator.logs logbookgenerator.logs.setup_logging logbookgenerator.main logbookgenerator.utilities logbookgenerator.utilities.file_handling logbookgenerator.utilities.validation

P

parse_input_directory() (in module logbookgenerator.computation.parsing) parse_weekly_directories() (in module logbookgenerator.computation.parsing) Paths (class in logbookgenerator.config.paths)

POSSIBLE_LOGGING_LEVELS (logbookgenerator.config.constants.Constants attribute) process_block_comment() (in module logbookgenerator.computation.code_processing) process_code_comments() (in module logbookgenerator.computation.code_processing) process_inline_comment() (in module logbookgenerator.computation.code_processing)

R

render_template() (in module logbookgenerator.computation.render_context)

S

save_file() (in module logbookgenerator.utilities.file_handling) SEMESTER_CHOICES (logbookgenerator.config.constants.Constants attribute)

setup_logging() (in module logbookgenerator.logs.setup_logging) SUCCESS_CODE (logbookgenerator.config.constants.Constants attribute) SUCCESS_TEXT (logbookgenerator.config.constants.Constants attribute)

T

TASK_ANNOTATION (logbookgenerator.config.constants.Constants attribute) temp_dir (logbookgenerator.config.paths.Paths attribute)

TEMPLATES_PATH (logbookgenerator.config.paths.Paths attribute) temporary_clone() (logbookgenerator.config.paths.Paths class method)

V

validate_date() (in module logbookgenerator.utilities.validation) validate_input_directory() (in module logbookgenerator.utilities.validation)

validate_student_id() (in module logbookgenerator.utilities.validation) validate_year() (in module logbookgenerator.utilities.validation)

W

WEEK_ANNOTATION (logbookgenerator.config.constants.Constants attribute)

Y

YEAR_REGEX_FORMAT (logbookgenerator.config.constants.Constants attribute)