FrontendSiteSettings¶
- class FrontendSiteSettings[source]¶
The JSON representation of options visible to all users.
- new_auto_test_ubuntu_20_04_base_image_ids: Just[Sequence[str]] | _Nothing[Sequence[str]] = Nothing¶
The base image that should be used for Ubuntu 20.04.
- new_auto_test_ubuntu_24_04_base_image_ids: Just[Sequence[str]] | _Nothing[Sequence[str]] = Nothing¶
The base image that should be used for Ubuntu 24.04.
- quiz_minimum_questions_for_dropdown: Just[int] | _Nothing[int] = Nothing¶
The minimum number of questions a quiz needs in order to display a dropdown of all questions.
- login_token_before_time: Just[Sequence[timedelta]] | _Nothing[Sequence[timedelta]] = Nothing¶
This determines how long before the exam we will send the login emails to the students (only when enabled of course).
- access_token_toast_warning_time: Just[timedelta] | _Nothing[timedelta] = Nothing¶
The amount of time before an access token expires when we will show a toast message warning the user that their session is about to expire.
- access_token_modal_warning_time: Just[timedelta] | _Nothing[timedelta] = Nothing¶
The amount of time before an access token expires when we will show a modal with a warning that the user’s session is about to expire.
- max_plagiarism_matches: Just[int] | _Nothing[int] = Nothing¶
The maximum amount of matches of a plagiarism run that we will store. If there are more matches than this they will be discarded.
- assignment_default_grading_scale: Just[Literal['percentage', 'points']] | _Nothing[Literal['percentage', 'points']] = Nothing¶
The default value for the grading scale of new assignments.
- assignment_default_grading_scale_points: Just[Fraction] | _Nothing[Fraction] = Nothing¶
The default points grading scale points of new assignments.
- blackboard_zip_upload_enabled: Just[bool] | _Nothing[bool] = Nothing¶
If enabled teachers are allowed to bulk upload submissions (and create users) using a zip file in a format created by Blackboard.
- register_enabled: Just[bool] | _Nothing[bool] = Nothing¶
Should it be possible to register on the website. This makes it possible for any body to register an account on the website.
- student_payment_main_option: Just[Literal['coupon', 'stripe']] | _Nothing[Literal['coupon', 'stripe']] = Nothing¶
Define what will be shown as the main option for student payment, the default will show stripe as the main payment option.
- grading_notifications_enabled: Just[bool] | _Nothing[bool] = Nothing¶
Whether teachers have access to the assignment manager - notifications panel, which gives control over when to send notifications to graders to finish their job, and also allows teachers to provide email(s) to notify when all graders are finished.
- assignment_percentage_decimals: Just[int] | _Nothing[int] = Nothing¶
Number of decimals for percentage-based grades in assignments, this also determines which decimal position the grade is rounded to.
- assignment_point_decimals: Just[int] | _Nothing[int] = Nothing¶
Number of decimals for point-based grades in assignments, this also determines which decimal position the grade is rounded to.
- lti_lock_date_copying_enabled: Just[bool] | _Nothing[bool] = Nothing¶
Should the lock date be copied from the LMS through LTI, or should we allow the user to set it in CodeGrade.
- assignment_max_points_enabled: Just[bool] | _Nothing[bool] = Nothing¶
Whether the “Max Points” field within the assignment general settings is enabled. If disabled, teachers will not be able to award extra points for assignments.
- inline_rubric_viewer_enabled: Just[bool] | _Nothing[bool] = Nothing¶
Whether the submission rubric viewer uses inline when the tab view does not fit. On the submission page we show the rubric viewer that will allow the teacher to fill in the rubric and the student to view their score in the different categories. With this feature enabled, we calculate whether all of the categories fit on a single line, and otherwise use a dropdown with previous and next buttons to select categories.
- hide_code_editor_output_viewer_with_only_quiz_steps: Just[bool] | _Nothing[bool] = Nothing¶
Whether we will hide all of the steps in the code editor sidebar output viewer if we have in a quiz-only atv2 config.
- hide_code_editor_filetree_controls_with_only_quiz_steps: Just[bool] | _Nothing[bool] = Nothing¶
Whether we will hide the buttons to add a file and a directory in the code editor, if we have a quiz-only atv2 config.
Whether we update the simple submission mode navigation to check if we have an editor session which is later than the submission when we launch the assignment. This feature is only available when the simple submission mode is enabled. Be mindful of turning this on when the tenant uses deadlines.
- display_grades_enabled: Just[bool] | _Nothing[bool] = Nothing¶
Whether we should show the grades of submissions created within this tenant. This will not hide the rubric results, only the grades. This is meant to be used with LTI providers that apply penalties (for example when handing in late) outside of CodeGrade.
- default_submission_page_tab: Just[Literal['auto-test', 'code', 'feedback-overview', 'peer-feedback', 'smart']] | _Nothing[Literal['auto-test', 'code', 'feedback-overview', 'peer-feedback', 'smart']] = Nothing¶
The default tab to select when going to a submission.
- hide_no_deadline_enabled: Just[bool] | _Nothing[bool] = Nothing¶
Should we hide the “No deadline” message if no deadline or lock date is set.
- code_editor_start_on_assignment_description: Just[bool] | _Nothing[bool] = Nothing¶
Whether to open the assignment description as the first file in the Code Editor, if the assignment has one, or the first file in the file tree.
- ai_assistant_enabled: Just[bool] | _Nothing[bool] = Nothing¶
The main feature flag for all the AI assistant capabilities in codegrade, whether we enable the ai assistant to be inside the app.
- assistant_models: Just[Sequence[str]] | _Nothing[Sequence[str]] = Nothing¶
Which LLM models are allowed to create a new assistant with. Defines the entire list, which means it can also be used to deprecate models by removing them. Beware that adding something to this list does not automatically add support for in the system to actually use the LLM through bedrock. For that we require to set up our deploy config to allow it. Note: The ground truth for which models are actually set up is defined in our app configuration, this simply can be used to disable any model that is configured to no longer allow it. Similarly, adding an unknown model in this list will not suddenly enable it for use.