codegrade 17.0.26__tar.gz → 17.0.27__tar.gz

{codegrade-17.0.26 → codegrade-17.0.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codegrade
-Version: 17.0.26
+Version: 17.0.27
 Summary: A client library for accessing CodeGrade
 Project-URL: Documentation, https://python.api.codegrade.com
 License-Expression: AGPL-3.0-only OR BSD-3-Clause-Clear

{codegrade-17.0.26 → codegrade-17.0.27}/docs/conf.py

@@ -39,7 +39,7 @@ author = "CodeGrade Team"
 # built documents.
 #
 # The short X.Y version.
-version = "17.0.26"
+version = "17.0.27"
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -103,7 +103,7 @@ html_js_files = ["toggle.js"]
 
 html_favicon = "_static/favicon/favicon.ico"
 html_logo = "_static/images/logo.svg"
-html_title = "CodeGrade 17.0.26"
+html_title = "CodeGrade 17.0.27"
 
 # -- Extension configuration -------------------------------------------------
 

codegrade-17.0.27/docs/models/AssistantModelsSetting.rst

@@ -0,0 +1,9 @@
+AssistantModelsSetting
+======================
+
+.. currentmodule:: codegrade.models.assistant_models_setting
+
+.. autoclass:: AssistantModelsSetting
+   :members: name, value
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

{codegrade-17.0.26 → codegrade-17.0.27}/docs/models/FrontendSiteSettings.rst

@@ -4,6 +4,6 @@ FrontendSiteSettings
 .. currentmodule:: codegrade.models.frontend_site_settings
 
 .. autoclass:: FrontendSiteSettings
-   :members: auto_test_max_time_command, auto_test_io_test_message, auto_test_io_test_sub_message, auto_test_run_program_message, auto_test_capture_points_message, auto_test_checkpoint_message, auto_test_unit_test_message, auto_test_code_quality_message, new_auto_test_ubuntu_20_04_base_image_ids, new_auto_test_ubuntu_24_04_base_image_ids, new_auto_test_build_max_command_time, new_auto_test_test_max_command_time, code_editor_output_viewer_title, quiz_minimum_questions_for_dropdown, exam_login_max_length, login_token_before_time, reset_token_time, site_email, access_token_toast_warning_time, access_token_modal_warning_time, max_lines, notification_poll_time, release_message_max_time, max_plagiarism_matches, auto_test_max_global_setup_time, auto_test_max_per_student_setup_time, assignment_default_grading_scale, assignment_default_grading_scale_points, blackboard_zip_upload_enabled, rubric_enabled_for_teacher_on_submissions_page, automatic_lti_role_enabled, register_enabled, groups_enabled, auto_test_enabled, course_register_enabled, render_html_enabled, email_students_enabled, peer_feedback_enabled, at_image_caching_enabled, student_payment_enabled, student_payment_main_option, editor_enabled, server_time_correction_enabled, grading_notifications_enabled, feedback_threads_initially_collapsed, server_time_diff_tolerance, server_time_sync_interval, assignment_percentage_decimals, assignment_point_decimals, output_viewer_animation_limit_lines_count, output_viewer_auto_expand_failed_steps, lti_lock_date_copying_enabled, assignment_max_points_enabled, course_gradebook_render_warning_size, course_bulk_register_enabled, csv_large_file_limit, csv_too_many_errors_limit, new_auto_test_old_submission_age, canvas_course_id_copying_enabled, new_auto_test_diff_viewer_enabled, github_template_repo_enabled, community_library, community_library_publishing, quality_comments_in_code_editor, sso_infer_global_staff_role, new_auto_test_uncollapsing_step_output_delay, assignment_description_on_teachers_submissions_page, inline_rubric_viewer_enabled, hide_code_editor_output_viewer_with_only_quiz_steps, hide_code_editor_filetree_controls_with_only_quiz_steps, simple_submission_navigate_to_latest_editor_session, display_grades_enabled, hide_empty_rubric_row_description, default_submission_page_tab, hide_no_deadline_enabled, retry_group_submission_grade_passback_enabled, code_editor_start_on_assignment_description, ai_assistant_enabled, assistant_tools_enabled, prompt_engineering_step_enabled, first_day_of_week_from_locale, inline_feedback_on_quizzes_enabled, quiz_single_question_mode_hide_run_button_enabled, warning_for_missing_newline_enabled, jupyter_notebook_editor_enabled, jupyter_notebook_running_enabled, coding_question_editor_reset_answer_enabled, coding_question_solution_enabled, download_editor_files_enabled, quiz_view_modes_enabled, regex_atv2_explanation_enabled, new_student_assignment_overview_enabled
+   :members: auto_test_max_time_command, auto_test_io_test_message, auto_test_io_test_sub_message, auto_test_run_program_message, auto_test_capture_points_message, auto_test_checkpoint_message, auto_test_unit_test_message, auto_test_code_quality_message, new_auto_test_ubuntu_20_04_base_image_ids, new_auto_test_ubuntu_24_04_base_image_ids, new_auto_test_build_max_command_time, new_auto_test_test_max_command_time, code_editor_output_viewer_title, quiz_minimum_questions_for_dropdown, exam_login_max_length, login_token_before_time, reset_token_time, site_email, access_token_toast_warning_time, access_token_modal_warning_time, max_lines, notification_poll_time, release_message_max_time, max_plagiarism_matches, auto_test_max_global_setup_time, auto_test_max_per_student_setup_time, assignment_default_grading_scale, assignment_default_grading_scale_points, blackboard_zip_upload_enabled, rubric_enabled_for_teacher_on_submissions_page, automatic_lti_role_enabled, register_enabled, groups_enabled, auto_test_enabled, course_register_enabled, render_html_enabled, email_students_enabled, peer_feedback_enabled, at_image_caching_enabled, student_payment_enabled, student_payment_main_option, editor_enabled, server_time_correction_enabled, grading_notifications_enabled, feedback_threads_initially_collapsed, server_time_diff_tolerance, server_time_sync_interval, assignment_percentage_decimals, assignment_point_decimals, output_viewer_animation_limit_lines_count, output_viewer_auto_expand_failed_steps, lti_lock_date_copying_enabled, assignment_max_points_enabled, course_gradebook_render_warning_size, course_bulk_register_enabled, csv_large_file_limit, csv_too_many_errors_limit, new_auto_test_old_submission_age, canvas_course_id_copying_enabled, new_auto_test_diff_viewer_enabled, github_template_repo_enabled, community_library, community_library_publishing, quality_comments_in_code_editor, sso_infer_global_staff_role, new_auto_test_uncollapsing_step_output_delay, assignment_description_on_teachers_submissions_page, inline_rubric_viewer_enabled, hide_code_editor_output_viewer_with_only_quiz_steps, hide_code_editor_filetree_controls_with_only_quiz_steps, simple_submission_navigate_to_latest_editor_session, display_grades_enabled, hide_empty_rubric_row_description, default_submission_page_tab, hide_no_deadline_enabled, retry_group_submission_grade_passback_enabled, code_editor_start_on_assignment_description, ai_assistant_enabled, assistant_tools_enabled, assistant_models, prompt_engineering_step_enabled, first_day_of_week_from_locale, inline_feedback_on_quizzes_enabled, quiz_single_question_mode_hide_run_button_enabled, warning_for_missing_newline_enabled, jupyter_notebook_editor_enabled, jupyter_notebook_running_enabled, coding_question_editor_reset_answer_enabled, coding_question_solution_enabled, download_editor_files_enabled, quiz_view_modes_enabled, regex_atv2_explanation_enabled, new_student_assignment_overview_enabled
    :inherited-members:
    :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

{codegrade-17.0.26 → codegrade-17.0.27}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "codegrade"
-version = "17.0.26"
+version = "17.0.27"
 description = "A client library for accessing CodeGrade"
 authors = []
 requires-python = ">=3.8.0,<4.0"

{codegrade-17.0.26 → codegrade-17.0.27}/src/codegrade/__init__.py

@@ -17,7 +17,7 @@ except ImportError:
     )
 
 __all__ = ("login", "AuthenticatedClient", "Client", "login_from_cli")
-__version__ = "17.0.26"
+__version__ = "17.0.27"
 
 _P = _ParamSpec("_P")
 _T = _t.TypeVar("_T")

{codegrade-17.0.26 → codegrade-17.0.27}/src/codegrade/client.py

@@ -577,7 +577,7 @@ class Client(_BaseClient):
         return httpx.Client(
             base_url=self.base_url,
             headers={
-                "User-Agent": "CodeGradeAPI/17.0.26",
+                "User-Agent": "CodeGradeAPI/17.0.27",
             },
             follow_redirects=True,
             transport=RetryingTransport(httpx.HTTPTransport()),
@@ -598,7 +598,7 @@ class AuthenticatedClient(_BaseClient):
             base_url=self.base_url,
             headers={
                 "Authorization": f"Bearer {self.token}",
-                "User-Agent": "CodeGradeAPI/17.0.26",
+                "User-Agent": "CodeGradeAPI/17.0.27",
             },
             follow_redirects=True,
             transport=RetryingTransport(httpx.HTTPTransport()),

{codegrade-17.0.26 → codegrade-17.0.27}/src/codegrade/models/__init__.py

@@ -90,6 +90,7 @@ from .assignment_submission_mode import (
 )
 from .assignment_template import AssignmentTemplate
 from .assignment_timeframes import AssignmentTimeframes
+from .assistant_models_setting import AssistantModelsSetting
 from .assistant_tools_enabled_setting import AssistantToolsEnabledSetting
 from .at_image_caching_enabled_setting import AtImageCachingEnabledSetting
 from .auto_test import AutoTest

{codegrade-17.0.26 → codegrade-17.0.27}/src/codegrade/models/all_site_settings.py

@@ -824,6 +824,8 @@ class AllSiteSettings(FrontendSiteSettings):
             res["ASSISTANT_TOOLS_ENABLED"] = to_dict(
                 self.assistant_tools_enabled.value
             )
+        if self.assistant_models.is_just:
+            res["ASSISTANT_MODELS"] = to_dict(self.assistant_models.value)
         if self.prompt_engineering_step_enabled.is_just:
             res["PROMPT_ENGINEERING_STEP_ENABLED"] = to_dict(
                 self.prompt_engineering_step_enabled.value
@@ -1122,6 +1124,7 @@ class AllSiteSettings(FrontendSiteSettings):
             code_editor_start_on_assignment_description=parsed.CODE_EDITOR_START_ON_ASSIGNMENT_DESCRIPTION,
             ai_assistant_enabled=parsed.AI_ASSISTANT_ENABLED,
             assistant_tools_enabled=parsed.ASSISTANT_TOOLS_ENABLED,
+            assistant_models=parsed.ASSISTANT_MODELS,
             prompt_engineering_step_enabled=parsed.PROMPT_ENGINEERING_STEP_ENABLED,
             first_day_of_week_from_locale=parsed.FIRST_DAY_OF_WEEK_FROM_LOCALE,
             inline_feedback_on_quizzes_enabled=parsed.INLINE_FEEDBACK_ON_QUIZZES_ENABLED,

codegrade-17.0.27/src/codegrade/models/assistant_models_setting.py

@@ -0,0 +1,58 @@
+"""The module that defines the ``AssistantModelsSetting`` model.
+
+SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
+"""
+
+from __future__ import annotations
+
+import typing as t
+from dataclasses import dataclass, field
+
+import cg_request_args as rqa
+
+from ..utils import to_dict
+
+
+@dataclass
+class AssistantModelsSetting:
+    """ """
+
+    name: t.Literal["ASSISTANT_MODELS"]
+    value: t.Optional[t.Sequence[str]]
+
+    raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
+
+    data_parser: t.ClassVar = rqa.Lazy(
+        lambda: rqa.FixedMapping(
+            rqa.RequiredArgument(
+                "name",
+                rqa.StringEnum("ASSISTANT_MODELS"),
+                doc="",
+            ),
+            rqa.RequiredArgument(
+                "value",
+                rqa.Nullable(rqa.List(rqa.SimpleValue.str)),
+                doc="",
+            ),
+        ).use_readable_describe(True)
+    )
+
+    def to_dict(self) -> t.Dict[str, t.Any]:
+        res: t.Dict[str, t.Any] = {
+            "name": to_dict(self.name),
+            "value": to_dict(self.value),
+        }
+        return res
+
+    @classmethod
+    def from_dict(
+        cls: t.Type[AssistantModelsSetting], d: t.Dict[str, t.Any]
+    ) -> AssistantModelsSetting:
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            name=parsed.name,
+            value=parsed.value,
+        )
+        res.raw_data = d
+        return res

{codegrade-17.0.26 → codegrade-17.0.27}/src/codegrade/models/frontend_site_settings.py

@@ -274,6 +274,16 @@ class FrontendSiteSettings:
     #: Whether the AI assistant in the app has access to tools to retrieve more
     #: information through requesting tool use while conversing with a user.
     assistant_tools_enabled: Maybe[bool] = 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.
+    assistant_models: Maybe[t.Sequence[str]] = Nothing
     #: The main feature flag for the ATv2 prompt engineering step. If enabled
     #: the step will be available within the AutoTestv2 editor.
     prompt_engineering_step_enabled: Maybe[bool] = Nothing
@@ -732,6 +742,11 @@ class FrontendSiteSettings:
                 rqa.SimpleValue.bool,
                 doc="Whether the AI assistant in the app has access to tools to retrieve more information through requesting tool use while conversing with a user.",
             ),
+            rqa.OptionalArgument(
+                "ASSISTANT_MODELS",
+                rqa.List(rqa.SimpleValue.str),
+                doc="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.",
+            ),
             rqa.OptionalArgument(
                 "PROMPT_ENGINEERING_STEP_ENABLED",
                 rqa.SimpleValue.bool,
@@ -1037,6 +1052,7 @@ class FrontendSiteSettings:
         self.assistant_tools_enabled = maybe_from_nullable(
             self.assistant_tools_enabled
         )
+        self.assistant_models = maybe_from_nullable(self.assistant_models)
         self.prompt_engineering_step_enabled = maybe_from_nullable(
             self.prompt_engineering_step_enabled
         )
@@ -1389,6 +1405,8 @@ class FrontendSiteSettings:
             res["ASSISTANT_TOOLS_ENABLED"] = to_dict(
                 self.assistant_tools_enabled.value
             )
+        if self.assistant_models.is_just:
+            res["ASSISTANT_MODELS"] = to_dict(self.assistant_models.value)
         if self.prompt_engineering_step_enabled.is_just:
             res["PROMPT_ENGINEERING_STEP_ENABLED"] = to_dict(
                 self.prompt_engineering_step_enabled.value
@@ -1529,6 +1547,7 @@ class FrontendSiteSettings:
             code_editor_start_on_assignment_description=parsed.CODE_EDITOR_START_ON_ASSIGNMENT_DESCRIPTION,
             ai_assistant_enabled=parsed.AI_ASSISTANT_ENABLED,
             assistant_tools_enabled=parsed.ASSISTANT_TOOLS_ENABLED,
+            assistant_models=parsed.ASSISTANT_MODELS,
             prompt_engineering_step_enabled=parsed.PROMPT_ENGINEERING_STEP_ENABLED,
             first_day_of_week_from_locale=parsed.FIRST_DAY_OF_WEEK_FROM_LOCALE,
             inline_feedback_on_quizzes_enabled=parsed.INLINE_FEEDBACK_ON_QUIZZES_ENABLED,

{codegrade-17.0.26 → codegrade-17.0.27}/src/codegrade/models/site_setting_input.py

@@ -36,6 +36,7 @@ from .assignment_percentage_decimals_setting import (
     AssignmentPercentageDecimalsSetting,
 )
 from .assignment_point_decimals_setting import AssignmentPointDecimalsSetting
+from .assistant_models_setting import AssistantModelsSetting
 from .assistant_tools_enabled_setting import AssistantToolsEnabledSetting
 from .at_image_caching_enabled_setting import AtImageCachingEnabledSetting
 from .auto_test_capture_points_message_setting import (
@@ -422,6 +423,7 @@ SiteSettingInput = t.Union[
     CodeEditorStartOnAssignmentDescriptionSetting,
     AiAssistantEnabledSetting,
     AssistantToolsEnabledSetting,
+    AssistantModelsSetting,
     PromptEngineeringStepEnabledSetting,
     FirstDayOfWeekFromLocaleSetting,
     InlineFeedbackOnQuizzesEnabledSetting,
@@ -560,6 +562,7 @@ SiteSettingInputParser = rqa.Lazy(
         ParserFor.make(CodeEditorStartOnAssignmentDescriptionSetting),
         ParserFor.make(AiAssistantEnabledSetting),
         ParserFor.make(AssistantToolsEnabledSetting),
+        ParserFor.make(AssistantModelsSetting),
         ParserFor.make(PromptEngineeringStepEnabledSetting),
         ParserFor.make(FirstDayOfWeekFromLocaleSetting),
         ParserFor.make(InlineFeedbackOnQuizzesEnabledSetting),