Welcome to Pedal’s documentation!

Pedal is a framework to analyze student’s code and provide feedback. Pedal is not only a collection of powerful program analysis tools, but is also built to give a model for what Feedback should be. Our goal is to elevate Feedback with Software Engineering and Instructional Design practices, to make it a central part of your course’s development rather than an afterthought.

Contents

• Introduction
  • An Example
  • Architecture
• Installation
  • PyPi
  • GitHub
  • Compatibility
• Teacher Quick Start Guide
  • Command Line Usage
  • Instructor Control Scripts
  • Custom Environments
  • Core Feedback Functions
  • Finding AST Patterns
  • Checking Execution Results
  • Calling Students’ Functions
  • Simple Assertions
  • Simple Unit Testing
  • Other Assertions
  • Resolver Feedback
• Teacher Examples
  • Basic Arithmetic Question
  • Basic Function Call Question
  • Student Defined Function
  • Complex Question
  • Medium Project
  • Large Project
• Teacher Reference
  • Core Commands
  • Feedback Functions
  • Formatter
  • TIFA
  • CAIT
  • Source
  • Sandbox
  • Static Assertions
  • Runtime Assertions
  • Pedal’s Type System
• Command-Line Interface
  • Command Line Modes
  • File Formats
  • Command Line Parameters
• Testing Your Tests
  • Verify Mode
  • Example
  • Output File Format
• Autograder Integrations
  • GradeScope
  • BlockPy
  • VPL
  • Web-CAT
  • Jupyter Notebooks
• Developers: Feedback Functions
  • Why Feedback Functions?
  • Feedback Function Concepts
  • Creating a Feedback Function
  • The Lifetime of a Feedback Function
  • The Metadata of Feedback Functions
  • Different Ways of Disabling Feedback
  • Methods of Feedback Functions
  • Overriding Existing Feedback Functions
• Developer API
  • Important Concepts
  • Core Commands
  • Report
  • Location
  • Feedback
  • Environment
  • Submission
  • Tools
• Developer Tools Reference
  • Source
  • TIFA
  • CAIT
  • Sandbox
  • Assertions
  • Questions
  • Extensions
• Internal Naming Conventions
• Necessary Libraries
  • Critical Standard Libraries
  • Non-Critical Standard Libraries
  • Optional Third Party Libraries
  • Compatiblity
• Compilation
  • Compiling Pedal for Skulpt
  • Compiling Pedal for Pyodide
• Researchers: Analyzing with Pedal
• Glossary
• Contact

Indices and tables

• Index

• Module Index

• Search Page