vangef/BBGradebookOrganiser
1
1
Fork 0
Code Issues Releases Activity

fixed list indentation for docs

Browse Source
This commit is contained in:
vangef
2023-07-23 22:23:21 +01:00
parent d2d74754f4
commit b6c52ac26f
3 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@@ -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: The Blackboard generated name for submission files must follow the pattern:
> ANYTHING_STUDENTNUMBER_attempt_DATETIME_FILENAME > ANYTHING_STUDENTNUMBER_attempt_DATETIME_FILENAME
## **Changes log** ## **Changelog**
See [***Changelog***](CHANGELOG.md) for notable changes and updates. See [***Changelog***](CHANGELOG.md) for notable changes and updates.

2
docs/inspect.md
View File

@@ -26,7 +26,7 @@ With **Inspect by hash** you can inspect the submissions for identical files (by
- 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) - 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** ## **Instructions**

20
docs/instructions.md
View File

@@ -45,25 +45,25 @@ While running, the script displays on the terminal information and stats about t
## **Post-run** ## **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: ## **Inspect by hash** :mag: