Skip to main content

lograder

A Python library for building programming assignment autograders. The central abstraction is a Pipeline of Step instances -- each step validates input, runs a process, and passes results forward.

Input -> Check -> Mixin -> Build -> Test

Installation

pip install lograder
# or for development:
uv sync --extra dev

Minimal example

from pathlib import Path
from lograder.pipeline.config import config
from lograder.pipeline.input.local_directory import LocalDirectory
from lograder.pipeline.check.project.simple_project import CMakeManifestCheck
from lograder.pipeline.build.cmake import CMakeBuild
from lograder.pipeline.test.output_compare import OutputCompareTest, OutputCompareCase
from lograder.pipeline.score import TestCaseScorer, AllOrNothingScorer, GradescopeConfig
from lograder.pipeline.pipeline import Pipeline

# Define test cases
cases = [
    OutputCompareCase(name="hello", args=[], expected_stdout="Hello, World!\n"),
    OutputCompareCase(name="echo",  args=["foo"], expected_stdout="foo\n"),
]

# Build the pipeline
pipeline = Pipeline()
pipeline.add(inp   := LocalDirectory())
pipeline.add(check := CMakeManifestCheck())
pipeline.add(build := CMakeBuild())
pipeline.add(tests := OutputCompareTest("hello", cases))

# Attach scorers
build.scorer = AllOrNothingScorer(10.0, label="Build")
tests.scorer = TestCaseScorer({"hello": 40.0, "echo": 50.0}, label="Correctness")

# Run
with config(root_directory=Path("/autograder/submission")):
    score = pipeline()

score.write_results_json(config=GradescopeConfig(visibility="visible"))

Documentation

Doc Contents
Getting started First autograder in 5 minutes
Concepts Pipeline, Step, Result, Manifest, Artifact
Input LocalDirectory, EnvironmentConfig
Check Manifest checks, SourceCheck, constraints
Build CMakeBuild, MakefileBuild, BashScriptBuild, PrebuiltArtifacts
Test All 9 test step types with full examples
Scoring Scorers, Gradescope output, results.json
Process layer TypedExecutable, CLIArgs, registry
Output / layouts Logging, HTML report, custom layouts
Examples Complete worked autograders

Design principles

  • Errors as values. Steps return Result[Ok, Err] rather than raising. A fatal Err return stops the pipeline; a yielded Err is logged and execution continues.
  • Typed data flow. Each step declares its input and output types. pipeline.validate_step_types() catches mismatches before the first submission runs.
  • No magic. Every process invocation goes through a TypedExecutable with validated CLIArgs. You can see exactly what command was run and what it produced.
  • Library only. lograder has no CLI and no service. You write a Python script; lograder is a collection of reusable building blocks.

Download files

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

Source Distribution

lograder-0.3.8.tar.gz (126.0 kB view details)

Uploaded Source

Built Distribution

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

lograder-0.3.8-py3-none-any.whl (193.6 kB view details)

Uploaded Python 3

File details

Details for the file lograder-0.3.8.tar.gz.

File metadata

  • Download URL: lograder-0.3.8.tar.gz
  • Upload date:
  • Size: 126.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for lograder-0.3.8.tar.gz
Algorithm Hash digest
SHA256 d88e1f398653d5bfd7aebe3a7f34b04e8918d07a3f37e57f5ed81e5623d79de5
MD5 7c730774f65ff584f8557fe2363c32a6
BLAKE2b-256 2d676447ef90bb5fb417f9039d4cac568fc41c954a89715a197954fb04558cda

See more details on using hashes here.

File details

Details for the file lograder-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: lograder-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 193.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for lograder-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 b81a41c966517ffe65f44c8b315c0767cd5c84da0e016f0dcfe854d0b54e60ec
MD5 6d36e9643870817b8761779bce3df023
BLAKE2b-256 1b9e0df79b806387761a9446840a4f2479fd4b58f00ec6fb586c7907faf3e20f

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.9

2 files

This release

0.3.8 This release

2 files

0.3.7

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.7

2 files

0.2.6

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page