Pedal
=====
.. image:: https://github.com/pedal-edu/pedal/workflows/Test%20and%20Lint/badge.svg
:alt: Unit Tests for 3.7, 3.8, 3.9
.. image:: https://github.com/pedal-edu/pedal/workflows/Build%20Documentation/badge.svg
:alt: Documentation
A collection of tools to analyze student's work in a pipeline.
Pedal not only provides some of these tools, but it provides a *framework*
around those tools.
Installation
============
Install from PyPi::
pip install pedal
Or install from the https://github.com/acbart/pedal repository
Important Concepts
==================
Pedal revolves around providing *Feedback Functions* that can be called in an
Instructor Control Script to generate *Feedback* for a *Submission*, which are
all attached to a *Report*. A *Resolver* can then transform that Feedback into
something that an *Environment* can hand off to a learner (or other interested
party). These Feedback Functions are organized into *Tools*.
.. image:: https://raw.githubusercontent.com/pedal-edu/pedal/master/docsrc/_static/pedal-overview-v3.png
One of our major goals is to attach metadata to feedback to enable easier
analysis, versioning, and evaluation. Although Instructor Control Scripts can
be written very imperatively to specify very complex (or simple) grading logic,
we are trying to reach an elegant, declarative style. This will enable tooling
to automatically generate reports on occurrences of feedback, connect to
datasets like those in the ProgSnap format, and allow us to "unit test our
unit tests".
One of our other goals for this project is to categorize Feedbacks' Conditions
and Responses, using concepts established by Narciss 2006. For example, we
say some Kinds of Responses are "hints" instead of "mistakes". We also say
that Conditions can be Categorized as being from "Specifications" or
"Runtime".
For more information, check out the docs for Pedal_.
.. _Pedal: https://pedal-edu.github.io/pedal
Raw data
{
"_id": null,
"home_page": "https://pedal-edu.github.io/pedal",
"name": "pedal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "feedback education teaching program analysis tifa cait sandbox pedal grading grader grade",
"author": "acbart,lukesg08",
"author_email": "acbart@udel.edu",
"download_url": "https://files.pythonhosted.org/packages/a5/4f/b5b90962404bc846150fcc24e5351828fe35483d0ca02c7d623061a5b308/pedal-2.6.4.tar.gz",
"platform": null,
"description": "Pedal\r\n=====\r\n\r\n.. image:: https://github.com/pedal-edu/pedal/workflows/Test%20and%20Lint/badge.svg\r\n :alt: Unit Tests for 3.7, 3.8, 3.9\r\n\r\n\r\n.. image:: https://github.com/pedal-edu/pedal/workflows/Build%20Documentation/badge.svg\r\n :alt: Documentation\r\n\r\nA collection of tools to analyze student's work in a pipeline.\r\nPedal not only provides some of these tools, but it provides a *framework*\r\naround those tools.\r\n\r\nInstallation\r\n============\r\n\r\nInstall from PyPi::\r\n \r\n pip install pedal\r\n\r\nOr install from the https://github.com/acbart/pedal repository\r\n\r\nImportant Concepts\r\n==================\r\n\r\nPedal revolves around providing *Feedback Functions* that can be called in an\r\nInstructor Control Script to generate *Feedback* for a *Submission*, which are\r\nall attached to a *Report*. A *Resolver* can then transform that Feedback into\r\nsomething that an *Environment* can hand off to a learner (or other interested\r\nparty). These Feedback Functions are organized into *Tools*.\r\n\r\n.. image:: https://raw.githubusercontent.com/pedal-edu/pedal/master/docsrc/_static/pedal-overview-v3.png\r\n\r\nOne of our major goals is to attach metadata to feedback to enable easier\r\nanalysis, versioning, and evaluation. Although Instructor Control Scripts can\r\nbe written very imperatively to specify very complex (or simple) grading logic,\r\nwe are trying to reach an elegant, declarative style. This will enable tooling\r\nto automatically generate reports on occurrences of feedback, connect to\r\ndatasets like those in the ProgSnap format, and allow us to \"unit test our\r\nunit tests\".\r\n\r\nOne of our other goals for this project is to categorize Feedbacks' Conditions\r\nand Responses, using concepts established by Narciss 2006. For example, we\r\nsay some Kinds of Responses are \"hints\" instead of \"mistakes\". We also say\r\nthat Conditions can be Categorized as being from \"Specifications\" or\r\n\"Runtime\".\r\n\r\nFor more information, check out the docs for Pedal_.\r\n\r\n.. _Pedal: https://pedal-edu.github.io/pedal\r\n",
"bugtrack_url": null,
"license": "Creative Commons Attribution-Noncommercial-Share Alike license",
"summary": "Tools to provide feedback on student code.",
"version": "2.6.4",
"project_urls": {
"Homepage": "https://pedal-edu.github.io/pedal"
},
"split_keywords": [
"feedback",
"education",
"teaching",
"program",
"analysis",
"tifa",
"cait",
"sandbox",
"pedal",
"grading",
"grader",
"grade"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2e0274324b975ce1619f393f7be320ce6e2c1b45472b428bb3cd43752afdc0e",
"md5": "f5a97ecde6c9a09ceefa165970c8a476",
"sha256": "251956d158f3edbe7fad3b9323f5769b4a81ac4107b5e00d983f6b9f0b2e18f7"
},
"downloads": -1,
"filename": "pedal-2.6.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5a97ecde6c9a09ceefa165970c8a476",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 359880,
"upload_time": "2024-09-20T19:02:00",
"upload_time_iso_8601": "2024-09-20T19:02:00.327030Z",
"url": "https://files.pythonhosted.org/packages/a2/e0/274324b975ce1619f393f7be320ce6e2c1b45472b428bb3cd43752afdc0e/pedal-2.6.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a54fb5b90962404bc846150fcc24e5351828fe35483d0ca02c7d623061a5b308",
"md5": "e75c4877d096b4f025902e9d1329a6b5",
"sha256": "624c6ab3e83400585e0f12236fc8822403e677846d668a5ca1be7259cb690a51"
},
"downloads": -1,
"filename": "pedal-2.6.4.tar.gz",
"has_sig": false,
"md5_digest": "e75c4877d096b4f025902e9d1329a6b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 262886,
"upload_time": "2024-09-20T19:02:02",
"upload_time_iso_8601": "2024-09-20T19:02:02.247229Z",
"url": "https://files.pythonhosted.org/packages/a5/4f/b5b90962404bc846150fcc24e5351828fe35483d0ca02c7d623061a5b308/pedal-2.6.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-20 19:02:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pedal"
}
JSON