diff --git a/docs/README.md b/docs/README.md index 9c06438..92fd7eb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,9 +16,9 @@ Optionally, you can inspect the submissions for identical files (by generating a - Extracts, and organises per student, the content of submitted compressed files with extensions: `.zip`, `.rar`, `.7z` - - Detects invalid/corrupt files + - Detects invalid/corrupt files - - Doesn't extract macOS system generated files (ignores directory *__MACOSX* inside the compressed file) + - Doesn't extract macOS system generated files (ignores directory *__MACOSX* inside the compressed file) - Deletes each compressed file after successful extraction into student directory @@ -28,13 +28,13 @@ Optionally, you can inspect the submissions for identical files (by generating a - Checks if any compressed files (from the contents of the submitted compressed files) have been extracted and organised per student - - The path of any extracted and organised compressed files will be displayed on the terminal - they need to be extracted manually + - The path of any extracted and organised compressed files will be displayed on the terminal - they need to be extracted manually - [Inspect by hash](inspect.md) generates and compares SHA256 hashes of all the submitted files, and detects files that are identical and have been submitted by multiple students. Two ways to inspect: - - Inspect gradebook: Before organising a gradebook - for identical files in the files submitted to *Blackboard* + - Inspect gradebook: Before organising a gradebook - for identical files in the files submitted to *Blackboard* - - Inspect submissions: After organising a gradebook - for identical files in the files extracted from any submitted *compressed* files + - Inspect submissions: After organising a gradebook - for identical files in the files extracted from any submitted *compressed* files ## **Instructions** @@ -49,6 +49,6 @@ See [***Inspect by hash***](inspect.md) for more information & details. The Blackboard generated name for submission files must follow the pattern: > ANYTHING_STUDENTNUMBER_attempt_DATETIME_FILENAME -## **Changes log** +## **Changelog** See [***Changelog***](CHANGELOG.md) for notable changes and updates. diff --git a/docs/inspect.md b/docs/inspect.md index bc37201..15f5f97 100644 --- a/docs/inspect.md +++ b/docs/inspect.md @@ -14,19 +14,19 @@ With **Inspect by hash** you can inspect the submissions for identical files (by - Generates SHA256 hashes for each submitted file, and outputs the list to a CSV file - - Can exclude files from hashing, if provided with a CSV file listing the file names (only applicable for *Inspect submissions*) + - Can exclude files from hashing, if provided with a CSV file listing the file names (only applicable for *Inspect submissions*) - Compares the generated hashes and finds any duplicates - ignores duplicates if they are by the same student/submission - Finds all files with the same hash and outputs the list to a CSV file with the following information: - - *Inspect gradebook*: `Student ID`, `file name`, `SHA256 hash` + - *Inspect gradebook*: `Student ID`, `file name`, `SHA256 hash` - - *Inspect submissions*: `Student ID`, `file path`, `file name`, `SHA256 hash` + - *Inspect submissions*: `Student ID`, `file path`, `file name`, `SHA256 hash` - File names and paths listed in the generated CSV files have hyperlinks to the actual files for a quick inspection of the file contents (or running the files, if executable) -Further analysis needs to be done manually by inspecting and filtering the generated output, depending on the submission and its files. +*Note:* Further analysis needs to be done manually by inspecting and filtering the generated output, depending on the submission and its files. ## **Instructions** diff --git a/docs/instructions.md b/docs/instructions.md index fbad383..74e8808 100644 --- a/docs/instructions.md +++ b/docs/instructions.md @@ -45,25 +45,25 @@ While running, the script displays on the terminal information and stats about t ## **Post-run** -- All submission files can be found - organised in directories per student number - in directory *BB_submissions*, under the sub-directory named after the gradebook name provided when running the script +All submission files can be found - organised in directories per student number - in directory *BB_submissions*, under the sub-directory named after the gradebook name provided when running the script. - - e.g. `organise_gradebook.py AssignmentX` creates the directory `AssignmentX` inside *BB_submissions* +- e.g. `organise_gradebook.py AssignmentX` creates the directory `AssignmentX` inside *BB_submissions* -- Each student directory contains: +Each student directory contains: - - the extracted files from the submitted `.zip`, `.rar`, `.7z` +- the extracted files from the submitted `.zip`, `.rar`, `.7z` - - the individually submitted files +- the individually submitted files - - the text file generated by Blackboard for the submission (which also contains any comments left by the student) +- the text file generated by Blackboard for the submission (which also contains any comments left by the student) -- All comments found in the gradebook are extracted in a text file in *BB_submissions*, with the gradebook name as prefix +All comments found in the gradebook are extracted in a text file in *BB_submissions*, with the gradebook name as prefix. - - e.g. `AssignmentX_comments.txt` will be created for gradebook `AssignmentX` +- e.g. `AssignmentX_comments.txt` will be created for gradebook `AssignmentX` -- Compressed files are deleted after successfully extracting and organising the contents +Compressed files are deleted after successfully extracting and organising the contents. - - Any invalid/corrupt compressed files are moved into folder `__BAD__` inside the gradebook directory +- Any invalid/corrupt compressed files are moved into folder `__BAD__` inside the gradebook directory ## **Inspect by hash** :mag: