Public API

Every Django application in edx-ora2 has an that is its public interface. If you are using one of these applications from the outside, you should only import things from that module. The ground rules for api modules are:

  1. All inputs and outputs must be trivially serializable to JSON. This means None, int, float, unicode, list, tuple, dict, and datetime.
  2. Returned objects should not have methods or business logic attached to them.
  3. Caller should assume that these calls can be moderately expensive, as they may one day move out of process and become network calls. So calling something a hundred times in a loop should be avoided.