learn Namespace Reference

Namespaces
namespace	answer
namespace	card
namespace	challenge
namespace	challengeresult
namespace	classgrade
namespace	initapp
namespace	problem
namespace	school
namespace	schooladministrator
namespace	schoolclass
namespace	schoolsystemadministrator
namespace	student
namespace	studylist
namespace	teacher

Functions
def	answersapi (g)
	Used to view and submit answers for a class, which can be viewed in the teacher's classroom web interface. More...
def	cardapi (g)
	Handles card management including setting child cards and problems. More...
def	challengeapi (g)
	Used to create and save challenge results. More...
def	challengesfunc (g)
	The helper function for /learn/challenges.html. More...
def	classapi (g)
	Handles the management of classes for a school. More...
def	cleanup (g)
	The standard Pafera app cleanup handler. More...
def	coursesfunc (g)
	The helper function for /learn/courses.html. More...
def	homefunc (g)
	The helper function for /learn/home.html. More...
def	opustotext (g)
	Speech recognition API using the Kaldi project. More...
def	problemapi (g)
	Manages problems, which are essentially a collection of cards. More...
def	schoolapi (g)
	Lets new students find a school that is right for them and handles general school management. More...
def	studentapi (g)
	Handles student management. More...
def	studylistapi (g)
	Lets the user view study list entries, results, and delete unneeded problems. More...
def	teacherapi (g)
	Handles teacher management. More...
def	texttomp3 (g)
	A simple text to speech API for students and teachers to play around with. More...

Variables
dictionary	PRICES
list	PROBLEM_CARDFIELDS
dictionary	ROUTES

Function Documentation

answersapi()

def learn.answersapi

(

g

)

Used to view and submit answers for a class, which can be viewed in the teacher's classroom web interface.

Functionality for putting students into groups, purchasing items, or setting prompts for the class are also included.

Definition at line 596 of file __init__.py.

cardapi()

def learn.cardapi

(

g

)

Handles card management including setting child cards and problems.

Definition at line 85 of file __init__.py.

challengeapi()

def learn.challengeapi

(

g

)

Used to create and save challenge results.

Note that only teachers can create challenges, and students can only save challenges which have already been started in /learn/challenges.html.

Also allows the user to view activity logs and statistics.

Definition at line 1169 of file __init__.py.

challengesfunc()

def learn.challengesfunc

(

g

)

The helper function for /learn/challenges.html.

This loads the challenge information for the JavaScript renderer.

Definition at line 3480 of file __init__.py.

classapi()

def learn.classapi

(

g

)

Handles the management of classes for a school.

You'll need to be an administrator for that school in order to make any changes to the class information. If you're a teacher, you can change autohomework and other class settings here.

Definition at line 2560 of file __init__.py.

cleanup()

def learn.cleanup

(

g

)

The standard Pafera app cleanup handler.

Since Pafera is focused on speed and fault tolerance rather than pure correctness, we don't use foreign keys and check constraints in the database layer. This function checks for broken links and rows and deletes them from the database.

Definition at line 3672 of file __init__.py.

coursesfunc()

def learn.coursesfunc

(

g

)

The helper function for /learn/courses.html.

This loads the main card, child cards, problems, and challenges for the JavaScript renderer.

Definition at line 3271 of file __init__.py.

homefunc()

def learn.homefunc

(

g

)

The helper function for /learn/home.html.

This loads the classes and challenges for the JavaScript renderer in addition to generating autohomework challenges and doing analyses on challenges which have ended.

Definition at line 3385 of file __init__.py.

opustotext()

def learn.opustotext

(

g

)

Speech recognition API using the Kaldi project.

Of course, it would be nice if we could simply use Google's speech recognition, but since Google servers are blocked in China, we have to use our own solution.

Note that speech recognition is a very expensive and memory intensive operation, so we use the DLock API to run only a single instance at a time. If you have a faster server, feel free to change the numprocesses variable to the number of processor cores that you have.

Definition at line 3190 of file __init__.py.

problemapi()

def learn.problemapi

(

g

)

Manages problems, which are essentially a collection of cards.

Note that you need to be a teacher in order to create or change problems. Normal students can only view problems.

Definition at line 384 of file __init__.py.

schoolapi()

def learn.schoolapi

(

g

)

Lets new students find a school that is right for them and handles general school management.

You'll need to be a school administrator or school system administrator in order to create or change school information.

Definition at line 2109 of file __init__.py.

studentapi()

def learn.studentapi

(

g

)

Handles student management.

Only a school administrator can use this API.

Definition at line 2933 of file __init__.py.

studylistapi()

def learn.studylistapi

(

g

)

Lets the user view study list entries, results, and delete unneeded problems.

Note that in most cases, problems are automatically added to the study list when a teacher updates a class, so deleting a problem that is in the study list for that class will only take effect until the next time the teacher changes the class.

Definition at line 1822 of file __init__.py.

teacherapi()

def learn.teacherapi

(

g

)

Handles teacher management.

Only a school administrator can use this API.

Definition at line 3039 of file __init__.py.

texttomp3()

def learn.texttomp3

(

g

)

A simple text to speech API for students and teachers to play around with.

You'll need to install the festival speech synthesis program on your server to use this.

Definition at line 3151 of file __init__.py.

Variable Documentation

PRICES

dictionary learn.PRICES

Initial value:

=  {
  'chair':    1,
  'sofa':     2,
  'desk':     3,
  'TV':       4,
  'door':     5,
  'window':   6,
  'table':    7,
  'bed':      8,
}

Definition at line 59 of file __init__.py.

PROBLEM_CARDFIELDS

list learn.PROBLEM_CARDFIELDS

Initial value:

=  [
  'problemid',
  'answerid',
  'explanationid',
  'choice1id',
  'choice2id',
  'choice3id',
  'choice4id',
  'choice5id',
  'choice6id',
  'choice7id',
]

Definition at line 71 of file __init__.py.

ROUTES

dictionary learn.ROUTES

Initial value:

=  {
  'cardapi':          cardapi,
  'problemapi':       problemapi,
  'answersapi':       answersapi,
  'schoolapi':        schoolapi,
  'classapi':         classapi,
  'studentapi':       studentapi,
  'teacherapi':       teacherapi,
  'challengeapi':     challengeapi,
  'studylistapi':     studylistapi,
  'texttomp3':        texttomp3,
  'opustotext':       opustotext,
  'coursesfunc':      coursesfunc,
  'homefunc':         homefunc,
  'challengesfunc':   challengesfunc,
  'cleanup':          cleanup,
}

Definition at line 3791 of file __init__.py.