bu-ist / bux-grader-framework

An edX external grader framework.

BU edX External Grader Framework

A simple framework for creating specialized external graders for your edX course.

See the demo course repository for an example course configuration. See the [configuration repository](configuration repository) for a more automated way to set up your grader environment.

Prerequisites

• A dedicated XQueue queue with authentication credentials
• RabbitMQ
• libxml2 and libxslt
• statsd (optional)

Contributing

Pull requests are welcome!

Pull down this repository and use pip to install development requirements:

$ git clone [email protected]:bu-ist/bux-grader-framework
$ pip install -r requirements.txt

Documentation

Follow pep257!

Package documentation lives in the docs directory and can be built in a variety of formats using sphinx.

cd docs
make html

The build directory (docs/_build) is excluded from VCS.

Tests

All unit tests live in the tests directory and can be run using nose.

$ nosetests

Coding Style

Follow pep8!

Run flake8 before you commit to make sure there aren't any violations:

$ flake8