diff --git a/ChangeLog.md b/ChangeLog.md index 4b790c1..c477c1a 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +## [v0.3.8] - 2024-05-28 +### Added +- Added a quickstart demo for Authoraide API. + ## [v0.3.7] - 2024-05-28 ### Fixed - Added the authoraide key in the services array of Init class. diff --git a/docs/quickstart/assessment/standalone_assessment.py b/docs/quickstart/assessment/standalone_assessment.py index 81f4e80..cacca7d 100644 --- a/docs/quickstart/assessment/standalone_assessment.py +++ b/docs/quickstart/assessment/standalone_assessment.py @@ -32,6 +32,13 @@ "domain": host, } +# Author Aide does not accept user_id so we need a separate security object +authorAideSecurity = { + "consumer_key": config.consumer_key, + # Change to the domain used in the browser, e.g. 127.0.0.1, learnosity.com + "domain": host, +} + # Items API configuration parameters. items_request = { # Unique student identifier, a UUID generated above. @@ -261,6 +268,16 @@ } } +# Author Aide API configuration parameters. +author_aide_request = { + "user": { + "id": 'python-demo-user', + "firstname": 'Demos', + "lastname": 'User', + "email": 'demos@learnosity.com' + } +} + # Set up Learnosity initialization data. initItems = Init( "items", security, config.consumer_secret, @@ -287,12 +304,18 @@ request = question_editor_request ) +initAuthorAide = Init( + "authoraide", authorAideSecurity, config.consumer_secret, + request = author_aide_request +) + # Generated request(initOptions) w.r.t all apis generated_request_Items = initItems.generate() generated_request_Questions = initQuestions.generate() generated_request_Author = initAuthor.generate() generated_request_Reports = initReports.generate() generated_request_QuestionEditor = initQuestionEditor.generate() +generated_request_AuthorAide = initAuthorAide.generate() # - - - - - - Section 2: your web page configuration - - - - - -# @@ -348,6 +371,10 @@ def do_GET(self): Question Editor API Here + + Author Aide API + Here + @@ -492,6 +519,29 @@ def do_GET(self): response = template.render(name='Standalone Question Editor API Example', generated_request=generated_request_QuestionEditor) self.createResponse(response) + if self.path.endswith("/authoraideapi"): + # Define the page HTML, as a Jinja template, with {{variables}} passed in. + template = Template(""" + + +

{{ name }}

+ +
+ + + + + + + """) + + # Render the page template and grab the variables needed. + response = template.render(name='Author Aide API Example', generated_request=generated_request_AuthorAide) + + self.createResponse(response) + def main(): web_server = HTTPServer((host, port), LearnosityServer) print("Server started http://%s:%s. Press Ctrl-c to quit." % (host, port)) diff --git a/learnosity_sdk/_version.py b/learnosity_sdk/_version.py index 6910e48..30a2b65 100644 --- a/learnosity_sdk/_version.py +++ b/learnosity_sdk/_version.py @@ -1 +1 @@ -__version__ = 'v0.3.7' +__version__ = 'v0.3.8'