https://github.com/mitodl/mitx-grading-library

The MITx Grading Library, a python grading library for edX
https://github.com/mitodl/mitx-grading-library

edx grading-library

Last synced: 6 days ago
JSON representation

The MITx Grading Library, a python grading library for edX

• Host: GitHub
• URL: https://github.com/mitodl/mitx-grading-library
• Owner: mitodl
• License: bsd-3-clause
• Created: 2017-10-25T15:37:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-25T19:56:51.000Z (29 days ago)
• Last Synced: 2024-11-25T20:37:35.941Z (29 days ago)
• Topics: edx, grading-library
• Language: Python
• Homepage: https://edge.edx.org/courses/course-v1:MITx+grading-library+examples/
• Size: 6.74 MB
• Stars: 14
• Watchers: 11
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MITx Grading Library

[![Build Status](https://github.com/mitodl/mitx-grading-library/actions/workflows/ci.yaml/badge.svg)](https://github.com/mitodl/mitx-grading-library/actions) [![Coverage Status](https://codecov.io/gh/mitodl/mitx-grading-library/branch/master/graphs/badge.svg)](https://codecov.io/gh/mitodl/mitx-grading-library)

A library of graders for edX Custom Response problems.

Version 3.0.0 ([changelog](docs/changelog.md))

Copyright 2017-2024 Jolyon Bloomfield and Chris Chudzicki

Licensed under the [BSD-3 License](LICENSE).

We thank the MIT Office of Open Learning for their support.

**Table of Contents**

- [Demo Course](#demo-course)

- [Grader Documentation](#documentation-for-edx-course-authors)

- [Local Installation](#local-installation)

- [FAQ](#faq)

## Demo Course

A demonstration course for the MITx Grading Library can be viewed [here](https://edge.edx.org/courses/course-v1:MITx+grading-library+examples/). The source code for this course is contained in this repository [here](course/).

## Documentation for edX Course Authors

[Extensive documentation](https://mitodl.github.io/mitx-grading-library/) has been compiled for the configuration of the different graders in the library.

## Local Installation

This is not required but can be useful for testing configurations in Python, rather than in edX.

To install:

**Requirements:** An installation of Python 3.8 or 3.11 (current edX versions).

0. (Optional) Create and activate a new Python Virtual Environment.

1. Clone this repository and `cd` into it.

2. Run `pip install -r requirements-python38.txt` or `pip install -r requirements-python311.txt` to install the requirements based on the Python version you want to test.

3. Run `pytest` to check that tests are passing. (To invoke tests of just the documentation, you can run the following command: `python -m pytest --no-cov --disable-warnings docs/*`)

## FAQ

* What's this `voluptuous` thing?

[Voluptuous](https://github.com/alecthomas/voluptuous) is a library that handles configuration validation, while giving (hopefully) meaningful error messages. We use it to automate the checking of the configurations passed into the `mitxgraders` library. They need to be packaged together in the `python_lib.zip` file.