Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
E
edx-ora2
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
edx-ora2
Commits
52a5ef00
Commit
52a5ef00
authored
Jan 29, 2014
by
David Ormsbee
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Group things so that the RTD theme TOC will be more helpful.
parent
38f5f508
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
33 additions
and
20 deletions
+33
-20
doc/source/api.rst
+33
-8
doc/source/dev/conventions.rst
+0
-12
No files found.
doc/source/api.rst
View file @
52a5ef00
.. _api:
.. _api:
Public API
----------
Every Django application in edx-tim has an `api.py` 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.
Submissions
Submissions
-----------
***********
.. automodule:: submissions.api
.. automodule:: submissions.api
:members:
:members:
Peer Assessment
Peer Assessment
---------------
***************
.. automodule:: openassessment.peer.api
Apps
:members:
----
Submissions
***********
Internals
The Submissions app is responsible for:
=========
Submissions
1. Storing and retrieving student submissions for answering a given problem.
-----------
2. Storing and retriveing the raw scores assigned to those submissions.
3. Retrieving the raw scores for all items associated with a particular student
in a particular course.
This application is ignorant of the content of submissions, and assumes them to
simply be opaque unicode strings.
Models
++++++
.. automodule:: submissions.models
.. automodule:: submissions.models
:members:
:members:
doc/source/dev/conventions.rst
View file @
52a5ef00
Public Interface
Public Interface
----------------
----------------
Every Django application in edx-tim has an `api.py` 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.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment