Files
BBGradebookOrganiser/docs/README.md

61 lines
2.9 KiB
Markdown
Raw Normal View History

2023-07-17 03:17:43 +01:00
# **BBGradebookOrganiser**
Blackboard Gradebook Organiser
**Documentation**: [docs.vangef.net/BBGradebookOrganiser](https://docs.vangef.net/BBGradebookOrganiser)
**Source Code**: [github.com/vangef/BBGradebookOrganiser](https://github.com/vangef/BBGradebookOrganiser)
## **Description**
**Blackboard Gradebook Organiser** is a tool for organising a downloaded gradebook with assignment submissions from [Blackboard Learn ⧉](https://en.wikipedia.org/wiki/Blackboard_Learn).
The submission files are organised per student, by extracting the student number from the submission file names and creating a directory per student. Compressed files are extracted into the student's directory, and any remaining individually submitted files are also moved into the student's directory. Student comments from the submissions are also extracted into a single text file for convenient access and review.
Optionally, you can inspect the submissions for identical files (by generating and comparing SHA256 hashes) and detect if any files have been submitted by multiple students. See [Inspect by hash](inspect.md) for more information.
## **Features**
- Extracts, and organises per student, the content of submitted compressed files with extensions: `.zip`, `.rar`, `.7z`
2023-07-23 22:23:21 +01:00
- Detects invalid/corrupt files
2023-07-17 03:17:43 +01:00
- Skips extracting files and directories if their path contains any of the *ignored dirs*, as set in *settings.py* - ignored directories by default:
2024-03-02 02:39:02 +00:00
- `__MACOSX` (macOS system generated files)
2024-03-02 02:39:02 +00:00
- `vendor` (composer / laravel)
2024-03-02 02:39:02 +00:00
- `node_modules` (npm)
2023-07-17 03:17:43 +01:00
- Deletes each compressed file after successful extraction into student directory
- Organises per student any remaining individually submitted files
- Checks and extracts any comments from the student submission generated text files
- Checks if any compressed files (from the contents of the submitted compressed files) have been extracted and organised per student
2023-07-23 22:23:21 +01:00
- The path of any extracted and organised compressed files will be displayed on the terminal - they need to be extracted manually
2023-07-17 03:17:43 +01:00
- [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:
2023-07-23 22:23:21 +01:00
- Inspect gradebook: Before organising a gradebook - for identical files in the files submitted to *Blackboard*
2023-07-17 03:17:43 +01:00
2023-07-23 22:23:21 +01:00
- Inspect submissions: After organising a gradebook - for identical files in the files extracted from any submitted *compressed* files
2023-07-17 03:17:43 +01:00
## **Instructions**
See [***Instructions***](instructions.md) for more information & details.
## **Inspect by hash** :mag:
See [***Inspect by hash***](inspect.md) for more information & details.
## **General notes**
The Blackboard generated name for submission files must follow the pattern:
> ANYTHING_STUDENTNUMBER_attempt_DATETIME_FILENAME
2023-07-23 22:23:21 +01:00
## **Changelog**
2023-07-17 03:17:43 +01:00
See [***Changelog***](CHANGELOG.md) for notable changes and updates.