User documentation available on ReadTheDocs.

This is an initial prototype for redesigning Peer Grading and general Open Ended Submission Evaluation. This project is in the early stages of development and is not ready for general use.

Installation

The intent of this project is to be installed as Django apps that will be included in edx-platform.

For JavaScript minification and unit tests, you must install NodeJS.

To install dependencies and start the development ("workbench") server:

./scripts/workbench.sh

By default, the XBlock JavaScript will be combined and minified. To preserve indentation and line breaks in JavaScript source files:

DEBUG_JS=1 ./scripts/workbench.sh

Additional arguments are passed to runserver. For example, to start the server on port 8001:

./scripts/workbench.sh 8001

Running Tests

To run the Python and Javascript unit test suites:

./scripts/test.sh

To limit Python tests to a particular Django app:

./scripts/test.sh openassessment.xblock

To run just the JavaScript tests:

npm test

To run the JavaScript tests in Chrome so you can use the debugger:

./scripts/js-debugger.sh

Quality Check

Install pylint:

pip install pylint==0.28.0

Check for quality violations:

pylint apps

Disable quality violations on a line or file:

# pylint: disable=W0123,E4567

License

The code in this repository is licensed under version 3 of the AGPL unless otherwise noted.

Please see LICENSE.txt for details.

How to Contribute

Due to the very early stage of development we're at, we are not accepting contributions at this time. Large portions of the API can change with little notice.

Reporting Security Issues

Please do not report security issues in public. Please email [email protected]

Mailing List and IRC Channel

You can discuss this code on the edx-code Google Group or in the edx-code IRC channel on Freenode.