1. Bases

Bases define the API for a server that a user will interact with. Including things like routes to web pages and API endpoints.

• 1.1. book_server_api package
  • 1.1.1. Subpackages
    • 1.1.1.1. book_server_api.routers package
      • 1.1.1.1.1. Submodules
      • 1.1.1.1.2. Module contents
  • 1.1.2. Submodules
    • 1.1.2.1. book_server_api.core module
    • 1.1.2.2. book_server_api.localconfig module
      • LocalConfig
    • 1.1.2.3. book_server_api.main module
      • 1.1.2.3.1. Overview
      • 1.1.2.3.2. Detailed Module Description
      • init_graders()
      • lifespan()
  • 1.1.3. Module contents
• 1.2. rsmanage package
  • 1.2.1. Submodules
  • 1.2.2. rsmanage.core module
    • Config
    • checkEnvironment()
    • check_db_connection()
    • check_db_for_useinfo()
    • echoEnviron()
    • findProjectRoot()
    • find_github_url()
  • 1.2.3. Module contents

2. Components

Components are shared pieces of code that can be used by multiple bases. They are not meant to be used directly by a user. They are meant to be used by a base to provide functionality to a user.

• 2.1. cl_utils package
  • 2.1.1. Submodules
  • 2.1.2. cl_utils.core module
    • EnvType
    • async_stream_command()
    • chdir()
    • env
    • flush_print()
    • isdir()
    • isfile()
    • load_project_dotenv()
    • mkdir()
    • pushd
    • stream_command()
    • subprocess_streamer()
    • xqt()
  • 2.1.3. Module contents
• 2.2. configuration package
  • 2.2.1. Submodules
    • 2.2.1.1. configuration.core module
      • 2.2.1.1.1. Configuring Runestone Servers
      • BookServerConfig
      • DatabaseType
      • Settings
  • 2.2.2. Module contents
• 2.3. db package
  • 2.3.1. Submodules
    • 2.3.1.1. db.async_session module
      • check_not_null()
      • get_session()
      • init_models()
      • term_models()
    • 2.3.1.2. db.core module
    • 2.3.1.3. db.crud module
      • bucket_count()
      • build_checkin_payload()
      • check_datafile_exists()
      • check_domain_approval()
      • consume_reset_token()
      • copy_course_attributes()
      • count_courses()
      • count_distinct_student_answers()
      • count_enrolled_students()
      • count_matching_questions()
      • count_peer_messages()
      • count_useinfo_for()
      • create_answer_table_entry()
      • create_api_token()
      • create_assignment()
      • create_assignment_question()
      • create_book_author()
      • create_code_entry()
      • create_course()
      • create_course_attribute()
      • create_course_instructor()
      • create_deadline_exception()
      • create_domain_approval()
      • create_editor_for_basecourse()
      • create_group()
      • create_initial_courses_users()
      • create_instructor_course_entry()
      • create_invoice_request()
      • create_library_book()
      • create_lti1p1_config()
      • create_lti_course()
      • create_membership()
      • create_question()
      • create_question_grade_entry()
      • create_selected_question()
      • create_timed_exam_entry()
      • create_traceback()
      • create_useinfo_entry()
      • create_user()
      • create_user_chapter_progress_entry()
      • create_user_course_entry()
      • create_user_experiment_entry()
      • create_user_state_entry()
      • create_user_sub_chapter_progress_entry()
      • create_user_topic_practice()
      • delete_api_token()
      • delete_course_completely()
      • delete_course_instructor()
      • delete_datafile()
      • delete_deadline_exception()
      • delete_lti1p3_course()
      • delete_lti_course()
      • delete_one_user_topic_practice()
      • delete_user()
      • delete_user_course_entry()
      • delete_user_experiment_entries()
      • did_send_messages()
      • did_start_timed()
      • duplicate_assignment()
      • fetch_all_api_tokens()
      • fetch_all_assignment_stats()
      • fetch_all_course_attributes()
      • fetch_all_datafiles()
      • fetch_all_deadline_exceptions()
      • fetch_all_grades_for_assignment()
      • fetch_answers()
      • fetch_api_token()
      • fetch_assignment_question()
      • fetch_assignment_questions()
      • fetch_assignment_release_for_div_id()
      • fetch_assignment_scores()
      • fetch_assignments()
      • fetch_available_students_for_instructor_add()
      • fetch_base_course()
      • fetch_basecourse_courses()
      • fetch_books_by_author()
      • fetch_chapter_for_subchapter()
      • fetch_code()
      • fetch_code_for_sid()
      • fetch_course()
      • fetch_course_by_id()
      • fetch_course_instructors()
      • fetch_course_practice()
      • fetch_course_students()
      • fetch_courses_by_institution()
      • fetch_courses_for_user()
      • fetch_current_instructors_for_course()
      • fetch_datafile_by_acid()
      • fetch_deadline_exception()
      • fetch_grade()
      • fetch_gradebook()
      • fetch_group()
      • fetch_instructor_courses()
      • fetch_last_answer_table_entry()
      • fetch_last_course_access()
      • fetch_last_page()
      • fetch_last_poll_response()
      • fetch_last_useinfo_peergroup()
      • fetch_late_students_for_assignment()
      • fetch_library_book()
      • fetch_library_books()
      • fetch_lti1p1_config()
      • fetch_lti1p1_config_by_consumer()
      • fetch_lti1p3_assignments_by_rs_assignment_id()
      • fetch_lti1p3_assignments_by_rs_course_id()
      • fetch_lti1p3_config()
      • fetch_lti1p3_config_by_lti_data()
      • fetch_lti1p3_course()
      • fetch_lti1p3_course_by_id()
      • fetch_lti1p3_course_by_lti_data()
      • fetch_lti1p3_course_by_rs_course()
      • fetch_lti1p3_courses_by_lti_course_id()
      • fetch_lti1p3_grading_data_for_assignment()
      • fetch_lti1p3_user()
      • fetch_lti1p3_users_for_course()
      • fetch_lti_version()
      • fetch_matching_questions()
      • fetch_membership()
      • fetch_one_assignment()
      • fetch_one_course_attribute()
      • fetch_one_user_topic_practice()
      • fetch_page_activity_counts()
      • fetch_peer_useinfo()
      • fetch_poll_summary()
      • fetch_previous_selections()
      • fetch_problem_data()
      • fetch_qualified_questions()
      • fetch_question()
      • fetch_question_by_id()
      • fetch_question_count_per_subchapter()
      • fetch_question_grade()
      • fetch_questions_by_search_criteria()
      • fetch_questions_for_chapter_subchapter()
      • fetch_reading_assignment_data()
      • fetch_reading_assignment_spec()
      • fetch_recent_student_answers()
      • fetch_recent_useinfo()
      • fetch_selected_question()
      • fetch_source_code()
      • fetch_student_answers_in_timerange()
      • fetch_subchapters()
      • fetch_timed_assessments()
      • fetch_timed_exam()
      • fetch_top10_fitb()
      • fetch_useinfo_for_sid()
      • fetch_user()
      • fetch_user_by_email()
      • fetch_user_chapter_progress()
      • fetch_user_experiment()
      • fetch_user_sub_chapter_progress()
      • fetch_users_for_course()
      • fetch_viewed_questions()
      • gather_served_books()
      • generate_datafile_acid()
      • get_book_chapters()
      • get_book_subchapters()
      • get_course_origin()
      • get_courses_per_basecourse()
      • get_last_sent()
      • get_or_create_instance_id()
      • get_peer_votes()
      • get_repo_path()
      • get_students_per_basecourse()
      • has_submissions_after_deadline()
      • is_assigned()
      • is_author()
      • is_editor()
      • is_server_feedback()
      • remove_assignment_questions()
      • reorder_assignment_questions()
      • replace_user_experiment_entries()
      • reset_student_assessment()
      • search_exercises()
      • set_last_sent()
      • set_manual_total()
      • set_reset_token()
      • update_assignment()
      • update_assignment_exercises()
      • update_assignment_question()
      • update_assignment_released()
      • update_assignment_threshold()
      • update_course_settings()
      • update_datafile()
      • update_deadline_exception()
      • update_library_book()
      • update_multiple_assignment_questions()
      • update_question()
      • update_question_grade_entry()
      • update_selected_question()
      • update_source_code()
      • update_source_code_sync()
      • update_sub_chapter_progress()
      • update_user()
      • update_user_state()
      • upsert_deadline_exception()
      • upsert_grade()
      • upsert_installation()
      • upsert_lti1p1_grade_link()
      • upsert_lti1p3_assignment()
      • upsert_lti1p3_config()
      • upsert_lti1p3_course()
      • upsert_lti1p3_user()
      • upsert_practice_grade_link()
      • user_in_course()
      • validate_user_credentials()
    • 2.3.1.4. db.models module
      • APIToken
      • AnswerMixin
      • Assignment
      • AssignmentQuestion
      • AuthEvent
      • AuthGroup
      • AuthMembership
      • AuthUser
      • AuthUserValidator
      • BookAuthor
      • Chapter
      • ClickableareaAnswers
      • Code
      • CodelensAnswers
      • Competency
      • CorrectAnswerMixin
      • CourseAttribute
      • CourseInstructor
      • CourseLtiMap
      • CoursePractice
      • Courses
      • DeadlineException
      • DictableMixin
      • DomainApprovals
      • DragndropAnswers
      • EditorBasecourse
      • EncryptedString
      • FitbAnswers
      • Grade
      • IdMixin
      • Installation
      • InvoiceRequest
      • Library
      • LpAnswers
      • Lti1p3Assignment
      • Lti1p3Conf
      • Lti1p3Course
      • Lti1p3User
      • LtiKey
      • MatchingAnswers
      • MchoiceAnswers
      • MicroParsonsAnswers
      • ParsonsAnswers
      • Payment
      • PracticeGrade
      • Question
      • QuestionGrade
      • QuestionTag
      • RunestoneComponentDict
      • SelectedQuestion
      • ShortanswerAnswers
      • SourceCode
      • SpliceAnswers
      • SubChapter
      • SubChapterTaught
      • Tag
      • TelemetryState
      • TimedExam
      • TraceBack
      • UnittestAnswers
      • Useinfo
      • UserChapterProgress
      • UserCourse
      • UserExperiment
      • UserState
      • UserSubChapterProgress
      • UserTopicPractice
      • UserTopicPracticeCompletion
      • UserTopicPracticeFeedback
      • UserTopicPracticeLog
      • UserTopicPracticeSurvey
      • Web2PyBoolean
      • Web2pySessionRunestone
      • WebWorkAnswers
      • register_answer_table()
  • 2.3.2. Module contents
• 2.4. logging package
  • 2.4.1. Submodules
    • 2.4.1.1. logging.applogger module
      • 2.4.1.1.1. Configure logging for the application
      • get_log_level()
    • 2.4.1.2. logging.core module
  • 2.4.2. Module contents
• 2.5. response_helpers package
  • 2.5.1. Submodules
    • 2.5.1.1. response_helpers.core module
      • 2.5.1.1.1. Response Helpers for FastAPI
      • canonical_utcnow()
      • canonicalize_tz()
      • construct_course_url()
      • get_react_imports()
      • get_webpack_static_imports()
      • http_422error_detail()
      • make_json_response()
      • safe_join()
  • 2.5.2. Module contents
    • construct_course_url()
    • safe_join()
• 2.6. Templates
• 2.7. validation package
  • 2.7.1. Submodules
    • 2.7.1.1. validation.core module
    • 2.7.1.2. validation.schemas module
      • AssessmentRequest
      • AssignmentIncoming
      • AssignmentQuestionIncoming
      • AssignmentQuestionUpdateDict
      • BaseModelNone
      • CopyQuestionRequest
      • CreateExercisesPayload
      • ExercisesSearchRequest
      • LastPageData
      • LastPageDataIncoming
      • LogItemIncoming
      • LogRunIncoming
      • PeerMessage
      • QuestionIncoming
      • ReadingAssignmentSpec
      • ScoringSpecification
      • SearchSpecification
      • SelectQRequest
      • TimezoneRequest
      • UpdateAssignmentExercisesPayload
      • ValidateQuestionNameRequest
      • sqlalchemy_to_pydantic()
  • 2.7.2. Module contents

More to come. The API documentation is a work in progress.