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.7.tar.gz (126.1 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.7-py3-none-any.whl (188.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lograder-0.3.7.tar.gz
  • Upload date:
  • Size: 126.1 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.7.tar.gz
Algorithm Hash digest
SHA256 a2effadda1e3e45f2f8944e12f745959ec9c522d603e86e493eadaeb739f67cc
MD5 d4c6a69f67698f5072c2d1d6d339c369
BLAKE2b-256 caf69b41566959c21871cc18b2997988cd2882aa3197dd6bb788d775df55a1b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lograder-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 188.7 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 138cb0ae9fb167ba08af15a19f070c37a6c990dbb3a65ac5eef8f49763d4b674
MD5 99c7ce8c5c040e52feb1a8f44c3bf419
BLAKE2b-256 6703765b9779f09773f423a741214b0b8dacf1e864f557e46510cb728151ab75

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.9

2 files

0.3.8

2 files

This release

0.3.7 This release

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