Skip to main content

A collection of tools for grading homework automatically

Project description

Otter-Autograder

An autograding system for teaching, primarily focused on Canvas LMS integration. Supports automated grading of programming assignments (via Docker), text submissions (like learning logs), quizzes, and manual exam grading with AI assistance.

Installation

pip install Otter-Autograder

Quick Start

1. Set up Canvas API credentials

Create a .env file in your working directory:

CANVAS_API_KEY=your_canvas_api_key_here
CANVAS_API_URL=https://your-institution.instructure.com

2. Create a grading configuration

Create a YAML file (e.g., assignments.yaml) defining your courses and assignments:

assignment_types:
  programming:
    kind: ProgrammingAssignment
    grader: template-grader
    settings:
      base_image_name: "your-docker-image"

courses:
  - name: "Your Course"
    id: 12345
    assignment_groups:
      - type: programming
        assignments:
          - id: 67890
            repo_path: "PA1"

3. Run the grader

grade-assignments --yaml assignments.yaml

Features

Supported Assignment Types

  • Programming Assignments: Docker-based grading with template matching and test execution
  • Text Submissions: AI-powered grading with rubric generation and clustering analysis
  • Quizzes: Canvas quiz grading support
  • Exams: Manual grading with AI-assisted name extraction and handwriting recognition
  • Web-based Grading UI: Modern interface for problem-first exam grading

Key Capabilities

  • Parallel execution with configurable worker threads
  • Automatic score scaling to Canvas points
  • Slack notifications for grading errors
  • Record retention for audit trails
  • Regrade support for existing submissions
  • Test mode for validation before full grading runs

Usage Examples

Grade with limited submissions (testing)

grade-assignments --yaml config.yaml --limit 5

Regrade existing submissions

grade-assignments --yaml config.yaml --regrade

Test submissions without pushing grades

grade-assignments --yaml config.yaml --test

Control parallelism

grade-assignments --yaml config.yaml --max_workers 2

Configuration

See the example_files/ directory for complete configuration examples:

  • example-programming_assignments.yaml: Docker-based grading
  • journal_assignments.yaml: Text submission grading
  • example-exams.yaml: Exam grading setup
  • example-template.yaml: All available options

Requirements

  • Python >= 3.12
  • Docker (for programming assignment grading)
  • Canvas API access
  • Optional: OpenAI or Anthropic API keys for AI-powered features

Documentation

For detailed documentation, see the documentation directory.

License

This project is licensed under the GPL-3.0-or-later license. See the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or pull request on GitHub.

Project details


Download files

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

Source Distribution

otter_autograder-0.1.10.tar.gz (969.9 kB view details)

Uploaded Source

Built Distribution

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

otter_autograder-0.1.10-py3-none-any.whl (92.4 kB view details)

Uploaded Python 3

File details

Details for the file otter_autograder-0.1.10.tar.gz.

File metadata

  • Download URL: otter_autograder-0.1.10.tar.gz
  • Upload date:
  • Size: 969.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","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":true}

File hashes

Hashes for otter_autograder-0.1.10.tar.gz
Algorithm Hash digest
SHA256 8286388b46f6123893739d5c1c277e6dcb0bcc7726a1e0b160b2f53401479c45
MD5 ded5ae368947095cb07c02e55543d86b
BLAKE2b-256 8842a0c56f457de281c6b3cc65bc0fb5f4848ef5ddf761bf8010aed12e3d4bc1

See more details on using hashes here.

File details

Details for the file otter_autograder-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: otter_autograder-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 92.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","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":true}

File hashes

Hashes for otter_autograder-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 4a62e6ca59376827471de56a9683f79b5b0353946830fbd8e5213250b813eeda
MD5 c86c28224bfdeed057f0e1c22abd577d
BLAKE2b-256 919ecc34aa18479abcc153b8cfdd955bcf6cde5794e0074784dab888d1212a2a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page