Generic Grader

A collection of generic tests for grading programming assignments.

This project is still in very early development. Expect breaking changes.

Installation

pip install generic-grader

Usage

Name the reference solution reference.py, and place it in a tests subdirectory of the directory containing the student's code.

Add a configuration file for the assignment in the tests subdirectory (e.g. tests/config.py). It might look something like this:

from parameterized import param
from generic_grader.style import comments # Import the tests you want to use
from generic_grader.utils.options import Options

# Create tests by calling each test type's build method.
# They should all start with the word `test_` to be discovered by unittest.
# Adding a number after `test_` can be used to control the run order.
# The argument is a list of `param` objects, each with an `Options` object.
# See the Options class for more information on the available options.
test_01_TestCommentLength = comments.build(
   [
      param(
          Options(
              sub_module="hello_user",
              hint="Check the volume of comments in your code.",
              entries=("Tim the Enchanter",),
          ),
      ),
      param(
          Options(
              sub_module="hello_user",
              hint="Check the volume of comments in your code.",
              entries=("King Arthur",),
          ),
      ),
   ]
)

Run the tests.
```
python -m unittest tests/config.py
```

Contributing

Clone the repo onto your machine.

HTTPS

git clone https://github.com/Purdue-EBEC/generic-grader.git

SSH

git clone git@github.com:Purdue-EBEC/generic-grader.git

Set up a new virtual environment in the cloned repo.
```
cd generic-grader
python3.12 -m venv .env3.12
```
Activate the virtual environment. If you are using VS Code, there may be a pop-up to do this automatically when working from this directory.
- Linux/macOS
```
source .env3.12/bin/activate
```
- Windows
```
.env3.12\Scripts\activate
```
Install tesseract-ocr
- on Linux
```
sudo apt install tesseract-ocr
```
- on macOS
```
brew install tesseract
```
- on Windows, download the latest installers from https://github.com/UB-Mannheim/tesseract/wiki
Install ghostscript
- on Linux
```
sudo apt install ghostscript
```
- on macOS
```
brew install ghostscript
```
- on Windows, download the latest installers from https://ghostscript.com/releases/gsdnld.html
Install the package. Note that this installs the package as editable, so edits will be automatically reflected in the installed package.
```
pip install -e .[dev]
```
or
```
uv sync --extra dev
```
Install the pre-commit hooks.
```
pre-commit install
```
Run the tests.
```
pytest
```
Make changes ...
Deactivate the virtual environment.

deactivate

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

generic_grader-0.2.9.tar.gz (152.9 kB view details)

Uploaded Aug 26, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

generic_grader-0.2.9-py3-none-any.whl (78.0 kB view details)

Uploaded Aug 26, 2026 Python 3

File details

Details for the file generic_grader-0.2.9.tar.gz.

File metadata

Download URL: generic_grader-0.2.9.tar.gz
Upload date: Aug 26, 2026
Size: 152.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for generic_grader-0.2.9.tar.gz
Algorithm	Hash digest
SHA256	`c42c7924ec9a967572a2b4854725635fc6b41eee4dd64b44b6c55be9a18bb1be`
MD5	`ccb4e3f5884a58cc798e0ac91d8cf60e`
BLAKE2b-256	`a22a00e0b8070b3aa24c4d391dc39937bbcb99a21eee5824349cef42c8bfe7de`

See more details on using hashes here.

File details

Details for the file generic_grader-0.2.9-py3-none-any.whl.

File metadata

Download URL: generic_grader-0.2.9-py3-none-any.whl
Upload date: Aug 26, 2026
Size: 78.0 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for generic_grader-0.2.9-py3-none-any.whl
Algorithm	Hash digest
SHA256	`30efd3825860c581d0acdf1c6cd84c0f16d4ce1fda1c4bcdefef9b5b6b1a03a4`
MD5	`351c8afba9734349e18b005bf71ad2db`
BLAKE2b-256	`f4ea4065aada7a756fd42e864cdbaf34b3f5b1656e7c63d97c167150b124dc7e`