534
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: + + + − + Line 31:
Line 34: − + − * sudo apt-get install python-setuptools+ − * sudo easy_install pyparsing+ − * sudo easy_install peak-rules+ − * sudo easy_install sqlalchemy+ + + + + + + + + Line 113:
Line 124: + + + + + + + + + Line 140:
Line 160: − + +
Math4Team/RIT/Projects/Question Support API (view source)
Revision as of 00:05, 6 June 2016
, 00:05, 6 June 2016Obsolete
{{Obsolete}}
{{TOCright}}
{{TOCright}}
==Question Support API==
==Question Support API==
{{:Math4Team/RIT/Projects/Question_Support_API/status}}
===Project Information===
===Project Information===
{{Definition_table
{{Definition_table
|Primary Project Contact| [[User:Enimihil|Greg Stevens]]
|Primary Project Contact| [[User:Enimihil|Greg Stevens]]
|Project Members| [[User:Enimihil|Greg Stevens]], [[User:Jfinney|Jameson Finney]], [[User:Bbl5660|Brian Long]], TODO: Add yourself here...
|Project Members| [[User:Enimihil|Greg Stevens]], [[User:Jfinney|Jameson Finney]], [[User:Bbl5660|Brian Long]]
|Source Repository| http://git.sugarlabs.org/projects/question-support-api
|Source Repository| http://git.sugarlabs.org/projects/question-support-api
}}
}}
** http://forums.aptana.com/viewtopic.php?f=37&t=7147&p=32918&hilit=ubuntu#p32918
** http://forums.aptana.com/viewtopic.php?f=37&t=7147&p=32918&hilit=ubuntu#p32918
====Dependencies that will be required / Installing them from the terminal====
====Dependencies====
<!-- Development for Linux / Python / Sugar Newbies! -->
<!-- Development for Linux / Python / Sugar Newbies! -->
;The following are required by the Question Support API.
:python-setuptools
:pyparsing
:peak-rules
:sqlalchemy
;You can install these via a linux terminal in this manner:
sudo apt-get install python-setuptools
sudo easy_install pyparsing
sudo easy_install peak-rules
sudo easy_install sqlalchemy
;Exception: When developing on a Fedora based distro, you'll need to install python-setuptools-devel for easy_install
===Motivation===
===Motivation===
for q in questions:
for q in questions:
do_question(q)
do_question(q)
===="How to Play/Use" for end user====
This is a requirement of the RIT OLPC seminar. The question doesn't exactly pertain to the API team's project, a more applicable question might be “How development of the API is done?” and “How do activity developers include / extend our API?”.
* The API is written in Python and has a set of [[#Dependencies|dependencies]], documented above.
* For activity developers to include our API into an activity, we're hoping to have the Sugar development team create a mechanism for developer's to install or include components. [[User:Enimihil|Greg Stevens]]'s has a bit more knowledge on this than [[User:bbl5660|Brian]] or [[User:Jfinney|Jameson]], but we will be looking into how to package our API, and how it can be accessed by other Activities. The issue with this later concept, is that Activities running on Sugar's platform are intentionally meant to be restricted to their own space inside of the Sugar environment. This means that we'll either need to hack something together to make other Activities include our API, or we'll need to collaborate with people at Sugar and figure out the best practice to include our API.
===Education Standards===
===Education Standards===
As a general API and not a standalone Activity, along with the nature of the API in specific, this project does not directly address any specific education standards or learning outcomes. It is reliant on educators to write questions, or have questions available to them in usable formats. As such, the potential educational standards this project could help to meet includes **any** standard where drilling or question/response evaluation is appropriate. (This includes a wider range of topic areas than the Math4 focus, even.)
As a general API and not a standalone Activity, along with the nature of the API in specific, this project does not directly address any specific education standards or learning outcomes. It is reliant on educators to write questions, or have questions available to them in usable formats. As such, the potential educational standards this project could help to meet includes **any** standard where drilling or question/response evaluation is appropriate. (This includes a wider range of topic areas than the Math4 focus, even.)
====A Teacher's Guide Abstract====
* Per the nature of this API, we've decided that our “Teacher Guide” will be more of an abstract. Below is a hypothetical situation of the Question Support API:Imagine a school manages a repository of quiz material that fit's some curriculum, and this repository is located at Moodle.org (for example the 4th Grade Math curriculum see: http://wiki.sugarlabs.org/go/User:Gdk/4th_Grade_Maths ). The teacher's use of our API design might go something like this:
* An activity that has extended / implemented our API is started by the teacher. The teacher is presented with an input field that requires a URI (URL). The teacher enters the URI of this week's quiz (i.e. http://moodle.org/SchoolName/ClassName/Week_11_Quiz/ ) The activity fetches the specified quiz data from the web, and presents the teacher with a summary and confirmation dialog box. Upon confirmation, the teacher can send / assign the quiz to the class. The class starts their corresponding activity which then also has a mechanism to either grab the assigned quiz from the Moodle.org server or from the local “School Server” (also-known-as the XS server, see: http://wiki.laptop.org/go/School_server ). The student's complete their assigned quiz, and data is sent back to the server for reporting / grading.
===Milestones===
===Milestones===
|Fun Towers| No API need or usage.
|Fun Towers| No API need or usage.
|Reporting Team| Simple export format documented at [[{{PAGENAMEE}}/API_Design|API Design]]. Futher integration work would be nice, but there is more work than could be done in a year along these lines (and neither team is prepared to embark on it).
|Reporting Team| Simple export format documented at [[{{PAGENAMEE}}/API_Design|API Design]]. Futher integration work would be nice, but there is more work than could be done in a year along these lines (and neither team is prepared to embark on it).
|Muthris| No contact from? Probably no API need or usage.
|Muthris| No API need or usage.
}}
}}
===See Also===
===See Also===
{{Special:PrefixIndex/{{PAGENAMEE}}/}}
{{Special:PrefixIndex/{{PAGENAMEE}}/}}