vangef/BBGradebookOrganiser
1
1
Fork 0
Code Issues Releases Activity

more READMEs re-formatting & edits

Browse Source
This commit is contained in:
vangef
2023-03-05 17:26:37 +00:00
parent ecce8de13c
commit 57573f8d03
3 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
BB_gradebooks/README.md
View File

@@ -2,6 +2,6 @@
Blackboard Gradebook Organiser Blackboard Gradebook Organiser
## Blackboard gradebooks directory: *BB_gradebooks* ## Blackboard gradebooks directory: [***BB_gradebooks***](.)
Create a directory with an appropriate name for the gradebook / assignment in this directory, and extract the downloaded gradebook .zip file in it. Create a directory with an appropriate name for the gradebook / assignment in this directory, and extract the downloaded gradebook *.zip* file in it.

10
BB_submissions/README.md
View File

@@ -2,13 +2,13 @@
Blackboard Gradebook Organiser Blackboard Gradebook Organiser
## Blackboard submissions directory: *BB_submissions* ## Blackboard submissions directory: [***BB_submissions***](.)
Gradebooks will be organised into this directory, in a subdirectory with the same name Gradebooks will be organised into this directory, in a subdirectory with the same name:
- Gradebook directory *AssignmentX* in *BB_gradebooks* will be organised into directory *AssignmentX* in *BB_submissions* - Gradebook directory `AssignmentX` in [*BB_gradebooks*](../BB_gradebooks/) will be organised into directory `AssignmentX` in [*BB_submissions*](.)
Also, a text file with all submission comments will be created in this directory, with the gradebook name as prefix Also, a text file with all submission comments will be created in this directory, with the gradebook name as prefix:
- e.g. *AssignmentX_comments.txt* will be created for gradebook *AssignmentX* - `AssignmentX_comments.txt` will be created for gradebook `AssignmentX`

22
README.md
View File

@@ -32,21 +32,21 @@ Optionally, after organising a gradebook, you can inspect the submissions to det
### Download gradebook ### Download gradebook
- Go to the course page on Blackboard 1. Go to the course page on Blackboard
- Go to *Grade Centre -> Full Grade Centre* 2. Go to *Grade Centre -> Full Grade Centre*
- Find the assignment and click on the arrow for more options, and select *Assignment File Download* 3. Find the assignment and click on the arrow for more options, and select *Assignment File Download*
- Select all (click *Show All* at the bottom first, to display all users) and click submit to generate the gradebook zip file 4. Select all (click *Show All* at the bottom first, to display all users) and click submit to generate the gradebook zip file
- Wait for the generated download link to appear, and click to download 5. Wait for the generated download link to appear, and click to download
### Extract gradebook ### Extract gradebook
Extract the downloaded gradebook in a new directory inside [*BB_gradebooks*](BB_gradebooks) Extract the downloaded gradebook in a new directory inside [*BB_gradebooks*](BB_gradebooks).
### Run script ### Organise gradebook
Before running the script for the first time, install the required packages: Before running the script for the first time, install the required packages:
@@ -54,13 +54,13 @@ Before running the script for the first time, install the required packages:
python -m pip install -r requirements.txt python -m pip install -r requirements.txt
``` ```
Note: If running on Linux/Mac, you also need to have `unrar` installed in order to be able to extract *.rar* files Note: If running on Linux/Mac, you also need to have `unrar` installed in order to be able to extract *.rar* files.
- `sudo apt install unrar` for Linux - `sudo apt install unrar` for Linux
- `brew install rar` for Mac - `brew install rar` for Mac
Provide the name of the directory (from section ***Extract gradebook*** above) as an argument when running the script: Run **`organise_gradebook.py`** and provide the name of the directory (from section ***Extract gradebook*** above) as an argument:
```python ```python
python organise_gradebook.py GRADEBOOK_DIR_NAME python organise_gradebook.py GRADEBOOK_DIR_NAME
@@ -72,7 +72,7 @@ While running, the script displays on the terminal information and stats about t
- All submission files can be found - organised in directories per student number - in directory [*BB_submissions*](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*](BB_submissions), under the sub-directory named after the gradebook name provided when running the script
- e.g. `python organise_gradebook.py AssignmentX` creates the directory `AssignmentX` inside [*BB_submissions*](BB_submissions) - e.g. `organise_gradebook.py AssignmentX` creates the directory `AssignmentX` inside [*BB_submissions*](BB_submissions)
- Each student directory contains the student's extracted and individually submitted files, and the text file generated by Blackboard with the submission (which also contains any comments left by the student) - Each student directory contains the student's extracted and individually submitted files, and the text file generated by Blackboard with the submission (which also contains any comments left by the student)
@@ -112,7 +112,7 @@ To inspect the submissions run:
python inspect_submissions.py GRADEBOOK_DIR_NAME python inspect_submissions.py GRADEBOOK_DIR_NAME
``` ```
**Note:** run ***after*** organising a gradebook with [*organise_gradebook.py*](organise_gradebook.py) **Note:** run ***after*** organising a gradebook with [*organise_gradebook.py*](organise_gradebook.py).
Generated CSV files can be found in directory `csv`, with the inspected submission's name as file name prefix - e.g. inspecting submissions for `AssignmentX` will create 2 CSV files: Generated CSV files can be found in directory `csv`, with the inspected submission's name as file name prefix - e.g. inspecting submissions for `AssignmentX` will create 2 CSV files: