vangef/BBGradebookOrganiser
1
1
Fork 0
Code Issues Releases Activity

updated docs: features (ignored dirs) + instructions (requirements, edit defaults)

Browse Source
This commit is contained in:
vangef
2024-03-02 02:15:30 +00:00
parent 0385e13da7
commit dd350e5190
2 changed files with 32 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/README.md
View File

@@ -18,7 +18,13 @@ Optionally, you can inspect the submissions for identical files (by generating a
- Detects invalid/corrupt files - Detects invalid/corrupt files
- Doesn't extract macOS system generated files (ignores directory *__MACOSX* inside the compressed file) - Skips extracting files and directories if their path contains any of the *ignored dirs*, as set in *settings.py* - ignored directories by default:
- `__MACOSX` (macOS system generated files)
- `vendor` (composer / laravel)
- `node_modules` (npm)
- Deletes each compressed file after successful extraction into student directory - Deletes each compressed file after successful extraction into student directory

29
docs/instructions.md
View File

@@ -18,21 +18,42 @@ Extract the downloaded gradebook in a new directory inside *BB_gradebooks*.
- e.g. for `AssignmentX` extract the gradebook in *BB_gradebooks*/`AssignmentX` - e.g. for `AssignmentX` extract the gradebook in *BB_gradebooks*/`AssignmentX`
## **Organise gradebook** ## **Script requirements**
Before running the script for the first time, install the required packages (*py7z*, *rarfile*): Before running the script for the first time, install the required python packages:
Option 1 - install `py7z`, `rarfile`
```console ```console
python -m pip install py7zr rarfile python -m pip install py7zr rarfile
``` ```
Note: If running on Linux/Mac, you also need to have `unrar` installed in order to be able to extract *.rar* files. Option 2 - install all packages, including `pandas` which is used in [Inspect by hash](inspect.md), using the requirements file
```console
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.
- `sudo apt install unrar` for Linux - `sudo apt install unrar` for Linux
- `brew install rar` for Mac - `brew install rar` for Mac
  ## (Optional) **Edit script defaults**
You can change the default settings by editing *utils/settings.py*. The main setting you might want to edit is `IGNORE_DIRS` - the list of names for directories, or files, to ignore when extracting from compressed files.
Ignored directories by default:
- `__MACOSX` (macOS system generated files)
- `vendor` (composer / laravel)
- `node_modules` (npm)
## **Organise gradebook**
To organise the gradebook run **`organise_gradebook.py`** and provide the name of the directory with the *extracted* gradebook (from section *Extract gradebook* above) as an argument. To organise the gradebook run **`organise_gradebook.py`** and provide the name of the directory with the *extracted* gradebook (from section *Extract gradebook* above) as an argument.
- e.g. for gradebook `AssignmentX` (in *BB_gradebooks*/`AssignmentX`) run: - e.g. for gradebook `AssignmentX` (in *BB_gradebooks*/`AssignmentX`) run: