logbookgenerator package

Subpackages

• logbookgenerator.computation package
  • Submodules
  • logbookgenerator.computation.code_processing module
    • process_block_comment()
    • process_code_comments()
    • process_inline_comment()
  • logbookgenerator.computation.comment_extraction module
    • extract_block_comment()
    • extract_comment_code()
    • extract_comment_content()
    • extract_comment_id()
  • logbookgenerator.computation.config_generation module
    • build_config_file()
  • logbookgenerator.computation.context_generation module
    • generate_coursework_context()
    • generate_logbook_contexts()
    • generate_tasks_context()
    • generate_week_context()
    • generate_weeks_context()
  • logbookgenerator.computation.parsing module
    • parse_input_directory()
    • parse_weekly_directories()
  • logbookgenerator.computation.render_context module
    • create_coursework()
    • create_logbook()
    • render_template()
  • Module contents
• logbookgenerator.config package
  • Submodules
  • logbookgenerator.config.constants module
    • Constants
      • Constants.ANSWER_ID_DELIMITERS
      • Constants.ANSWER_KEYWORD
      • Constants.BLOCK_COMMENT_MIDDLE
      • Constants.BLOCK_COMMENT_START
      • Constants.CODE_COMMENT_DELIMITER
      • Constants.COMMENT_END
      • Constants.COURSEWORK_REGEX
      • Constants.DATE_DATETIME_FORMAT
      • Constants.DATE_REGEX_FORMAT
      • Constants.DEFAULT_CONFIG_FILE
      • Constants.DEFAULT_INPUT_DIRECTORY
      • Constants.DEFAULT_LOG_SAVE_PATH
      • Constants.DEFAULT_MODULE_CODE
      • Constants.DEFAULT_MODULE_NAME
      • Constants.DEFAULT_OUTPUT_FILE
      • Constants.DEFAULT_STATEMENT_TEXT
      • Constants.DEFAULT_UNIVERSITY_DEPARTMENT
      • Constants.DEFAULT_UNIVERSITY_NAME
      • Constants.FORBIDDEN_CODE
      • Constants.ID_REGEX_FORMAT
      • Constants.INLINE_ANSWER_COMMENT
      • Constants.INLINE_COMMENT_START
      • Constants.JINJA_DATE_FORMAT
      • Constants.LOGGING_CONSOLE_FORMAT
      • Constants.LOGGING_DATE_FORMAT
      • Constants.LOGGING_LEVEL_CONSOLE_DEFAULT
      • Constants.LOGGING_LEVEL_LOGFILE_DEFAULT
      • Constants.LOGGING_LOGFILE_FORMAT
      • Constants.LOGGING_TIMESTAMP_FORMAT
      • Constants.LOGGING_TRACEBACKS
      • Constants.POSSIBLE_LOGGING_LEVELS
      • Constants.SEMESTER_CHOICES
      • Constants.SUCCESS_CODE
      • Constants.SUCCESS_TEXT
      • Constants.TASK_ANNOTATION
      • Constants.WEEK_ANNOTATION
      • Constants.YEAR_REGEX_FORMAT
  • logbookgenerator.config.paths module
    • Paths
      • Paths.TEMPLATES_PATH
      • Paths.temp_dir
      • Paths.temporary_clone()
    • cleanup_temporary_files()
  • Module contents
• logbookgenerator.integrations package
  • Module contents
• logbookgenerator.interface package
  • Submodules
  • logbookgenerator.interface.command_line module
    • command_line_interface()
  • Module contents
• logbookgenerator.logs package
  • Submodules
  • logbookgenerator.logs.setup_logging module
    • setup_logging()
  • Module contents
• logbookgenerator.utilities package
  • Submodules
  • logbookgenerator.utilities.file_handling module
    • create_clean_code_files()
    • load_yaml()
    • save_file()
  • logbookgenerator.utilities.validation module
    • validate_date()
    • validate_input_directory()
    • validate_student_id()
    • validate_year()
  • Module contents

Submodules

logbookgenerator.main module

main.py: Called when the package is ran as a script.

logbookgenerator.main.main() → None

Overall control flow of the application.

Notes

This function is the entry point for the application, so only really contains overall control flow logic. The actual work is done in the other modules, usually.

Module contents

Generates a logbook. Designed for the University of Lincoln’s Scientific Computing module.