codegrade 16.1.77__tar.gz → 16.1.80__tar.gz

{codegrade-16.1.77 → codegrade-16.1.80}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codegrade
-Version: 16.1.77
+Version: 16.1.80
 Summary: A client library for accessing CodeGrade
 License: AGPL-3.0-only OR BSD-3-Clause-Clear
 Requires-Python: >=3.8.0,<4.0

{codegrade-16.1.77 → codegrade-16.1.80}/codegrade/__init__.py

@@ -7,7 +7,7 @@ from functools import wraps
 from .client import AuthenticatedClient, Client
 
 __all__ = ("login", "AuthenticatedClient", "Client", "login_from_cli")
-__version__ = "16.1.77"
+__version__ = "16.1.80"
 
 
 @wraps(AuthenticatedClient.get)

{codegrade-16.1.77 → codegrade-16.1.80}/codegrade/client.py

@@ -538,7 +538,7 @@ class Client(_BaseClient):
         return httpx.Client(
             base_url=self.base_url,
             headers={
-                "User-Agent": "CodeGradeAPI/16.1.77",
+                "User-Agent": "CodeGradeAPI/16.1.80",
             },
             follow_redirects=True,
         )
@@ -558,7 +558,7 @@ class AuthenticatedClient(_BaseClient):
             base_url=self.base_url,
             headers={
                 "Authorization": f"Bearer {self.token}",
-                "User-Agent": "CodeGradeAPI/16.1.77",
+                "User-Agent": "CodeGradeAPI/16.1.80",
             },
             follow_redirects=True,
         )

{codegrade-16.1.77 → codegrade-16.1.80}/codegrade/models/__init__.py

@@ -600,6 +600,9 @@ from .plagiarism_run_plagiarism_course_as_json import (
 from .plagiarism_state import PlagiarismState
 from .post_oauth_token_data import PostOAuthTokenData
 from .present_preference import PresentPreference
+from .prompt_engineering_step_enabled_setting import (
+    PromptEngineeringStepEnabledSetting,
+)
 from .proxy import Proxy
 from .put_description_assignment_data import PutDescriptionAssignmentData
 from .put_enroll_link_course_data import PutEnrollLinkCourseData
@@ -741,6 +744,9 @@ from .user_info_with_role import UserInfoWithRole
 from .user_input import UserInput
 from .user_login_response import UserLoginResponse
 from .user_without_group import UserWithoutGroup
+from .warning_for_missing_newline_disabled_setting import (
+    WarningForMissingNewlineDisabledSetting,
+)
 from .weak_password_exception import WeakPasswordException
 from .weak_password_feedback import WeakPasswordFeedback
 from .webhook_base import WebhookBase

{codegrade-16.1.77 → codegrade-16.1.80}/codegrade/models/all_site_settings.py

@@ -1035,6 +1035,10 @@ class AllSiteSettings(FrontendSiteSettings):
             res["AI_ASSISTANT_ENABLED"] = to_dict(
                 self.ai_assistant_enabled.value
             )
+        if self.prompt_engineering_step_enabled.is_just:
+            res["PROMPT_ENGINEERING_STEP_ENABLED"] = to_dict(
+                self.prompt_engineering_step_enabled.value
+            )
         if self.first_day_of_week_from_locale.is_just:
             res["FIRST_DAY_OF_WEEK_FROM_LOCALE"] = to_dict(
                 self.first_day_of_week_from_locale.value
@@ -1051,6 +1055,10 @@ class AllSiteSettings(FrontendSiteSettings):
             res["QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_ENABLED"] = to_dict(
                 self.quiz_single_question_mode_hide_run_button_enabled.value
             )
+        if self.warning_for_missing_newline_disabled.is_just:
+            res["WARNING_FOR_MISSING_NEWLINE_DISABLED"] = to_dict(
+                self.warning_for_missing_newline_disabled.value
+            )
         if self.auto_test_heartbeat_interval.is_just:
             res["AUTO_TEST_HEARTBEAT_INTERVAL"] = to_dict(
                 self.auto_test_heartbeat_interval.value
@@ -1315,10 +1323,12 @@ class AllSiteSettings(FrontendSiteSettings):
             student_view_enabled=parsed.STUDENT_VIEW_ENABLED,
             code_editor_start_on_assignment_description=parsed.CODE_EDITOR_START_ON_ASSIGNMENT_DESCRIPTION,
             ai_assistant_enabled=parsed.AI_ASSISTANT_ENABLED,
+            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,
             pearson_try_out_coding_question_enabled=parsed.PEARSON_TRY_OUT_CODING_QUESTION_ENABLED,
             quiz_single_question_mode_hide_run_button_enabled=parsed.QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_ENABLED,
+            warning_for_missing_newline_disabled=parsed.WARNING_FOR_MISSING_NEWLINE_DISABLED,
             auto_test_heartbeat_interval=parsed.AUTO_TEST_HEARTBEAT_INTERVAL,
             auto_test_heartbeat_max_missed=parsed.AUTO_TEST_HEARTBEAT_MAX_MISSED,
             auto_test_max_jobs_per_runner=parsed.AUTO_TEST_MAX_JOBS_PER_RUNNER,

{codegrade-16.1.77 → codegrade-16.1.80}/codegrade/models/base_lti1p3_provider.py

@@ -22,7 +22,7 @@ class BaseLTI1p3Provider(BaseLTIProvider):
     """The base representation of an LTI 1.3 provider."""
 
     #: The LMS that is connected as this LTI provider.
-    lms: "t.Literal['Blackboard', 'Brightspace', 'Canvas', 'Moodle', 'Revel']"
+    lms: "t.Literal['Blackboard', 'Brightspace', 'Canvas', 'Moodle', 'Revel', 'XL']"
     #: The capabilities of this LMS
     capabilities: "LMSCapabilities"
     #: The LTI version used.
@@ -45,6 +45,7 @@ class BaseLTI1p3Provider(BaseLTIProvider):
                         "Canvas",
                         "Moodle",
                         "Revel",
+                        "XL",
                     ),
                     doc="The LMS that is connected as this LTI provider.",
                 ),

{codegrade-16.1.77 → codegrade-16.1.80}/codegrade/models/frontend_site_settings.py

@@ -340,6 +340,9 @@ class FrontendSiteSettings:
     #: The main feature flag for all the AI assistant capabilities in
     #: codegrade, whether we enable the ai assistant to be inside the app.
     ai_assistant_enabled: Maybe["bool"] = 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
     #: Whether to get the first day of the week in calendars from the user's
     #: configured locale. If disabled the first day of the week will default to
     #: Sunday.
@@ -352,6 +355,10 @@ class FrontendSiteSettings:
     #: assignment contains only quizzes with the "Run single questions" feature
     #: enabled.
     quiz_single_question_mode_hide_run_button_enabled: Maybe["bool"] = Nothing
+    #: Whether to disable being able to display the warning for missing
+    #: newlines in the code viewer. If we set disable=true, passing the
+    #: property to show the warning will be overridden and it will never show.
+    warning_for_missing_newline_disabled: Maybe["bool"] = Nothing
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -1159,6 +1166,15 @@ class FrontendSiteSettings:
                     " assistant to be inside the app."
                 ),
             ),
+            rqa.OptionalArgument(
+                "PROMPT_ENGINEERING_STEP_ENABLED",
+                rqa.SimpleValue.bool,
+                doc=(
+                    "The main feature flag for the ATv2 prompt engineering"
+                    " step. If enabled the step will be available within the"
+                    " AutoTestv2 editor."
+                ),
+            ),
             rqa.OptionalArgument(
                 "FIRST_DAY_OF_WEEK_FROM_LOCALE",
                 rqa.SimpleValue.bool,
@@ -1193,6 +1209,16 @@ class FrontendSiteSettings:
                     ' single questions" feature enabled.'
                 ),
             ),
+            rqa.OptionalArgument(
+                "WARNING_FOR_MISSING_NEWLINE_DISABLED",
+                rqa.SimpleValue.bool,
+                doc=(
+                    "Whether to disable being able to display the warning for"
+                    " missing newlines in the code viewer. If we set"
+                    " disable=true, passing the property to show the warning"
+                    " will be overridden and it will never show."
+                ),
+            ),
         ).use_readable_describe(True)
     )
 
@@ -1479,6 +1505,9 @@ class FrontendSiteSettings:
         self.ai_assistant_enabled = maybe_from_nullable(
             self.ai_assistant_enabled
         )
+        self.prompt_engineering_step_enabled = maybe_from_nullable(
+            self.prompt_engineering_step_enabled
+        )
         self.first_day_of_week_from_locale = maybe_from_nullable(
             self.first_day_of_week_from_locale
         )
@@ -1493,6 +1522,9 @@ class FrontendSiteSettings:
                 self.quiz_single_question_mode_hide_run_button_enabled
             )
         )
+        self.warning_for_missing_newline_disabled = maybe_from_nullable(
+            self.warning_for_missing_newline_disabled
+        )
 
     def to_dict(self) -> t.Dict[str, t.Any]:
         res: t.Dict[str, t.Any] = {}
@@ -1870,6 +1902,10 @@ class FrontendSiteSettings:
             res["AI_ASSISTANT_ENABLED"] = to_dict(
                 self.ai_assistant_enabled.value
             )
+        if self.prompt_engineering_step_enabled.is_just:
+            res["PROMPT_ENGINEERING_STEP_ENABLED"] = to_dict(
+                self.prompt_engineering_step_enabled.value
+            )
         if self.first_day_of_week_from_locale.is_just:
             res["FIRST_DAY_OF_WEEK_FROM_LOCALE"] = to_dict(
                 self.first_day_of_week_from_locale.value
@@ -1886,6 +1922,10 @@ class FrontendSiteSettings:
             res["QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_ENABLED"] = to_dict(
                 self.quiz_single_question_mode_hide_run_button_enabled.value
             )
+        if self.warning_for_missing_newline_disabled.is_just:
+            res["WARNING_FOR_MISSING_NEWLINE_DISABLED"] = to_dict(
+                self.warning_for_missing_newline_disabled.value
+            )
         return res
 
     @classmethod
@@ -1992,10 +2032,12 @@ class FrontendSiteSettings:
             student_view_enabled=parsed.STUDENT_VIEW_ENABLED,
             code_editor_start_on_assignment_description=parsed.CODE_EDITOR_START_ON_ASSIGNMENT_DESCRIPTION,
             ai_assistant_enabled=parsed.AI_ASSISTANT_ENABLED,
+            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,
             pearson_try_out_coding_question_enabled=parsed.PEARSON_TRY_OUT_CODING_QUESTION_ENABLED,
             quiz_single_question_mode_hide_run_button_enabled=parsed.QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_ENABLED,
+            warning_for_missing_newline_disabled=parsed.WARNING_FOR_MISSING_NEWLINE_DISABLED,
         )
         res.raw_data = d
         return res

{codegrade-16.1.77 → codegrade-16.1.80}/codegrade/models/lti1p3_provider_data.py

@@ -22,7 +22,7 @@ class LTI1p3ProviderData:
     #: The iss of the new provider
     iss: "str"
     #: The LMS that will be used for this connection
-    lms: "t.Literal['Canvas', 'Blackboard', 'Moodle', 'Brightspace', 'Revel']"
+    lms: "t.Literal['Canvas', 'Blackboard', 'Moodle', 'Brightspace', 'Revel', 'XL']"
     #: Use LTI 1.3
     lti_version: "t.Literal['lti1.3']"
     #: Label for the LTI provider
@@ -45,7 +45,12 @@ class LTI1p3ProviderData:
             rqa.RequiredArgument(
                 "lms",
                 rqa.StringEnum(
-                    "Canvas", "Blackboard", "Moodle", "Brightspace", "Revel"
+                    "Canvas",
+                    "Blackboard",
+                    "Moodle",
+                    "Brightspace",
+                    "Revel",
+                    "XL",
                 ),
                 doc="The LMS that will be used for this connection",
             ),

codegrade-16.1.80/codegrade/models/prompt_engineering_step_enabled_setting.py

@@ -0,0 +1,57 @@
+"""The module that defines the ``PromptEngineeringStepEnabledSetting`` model.
+
+SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
+"""
+
+import typing as t
+from dataclasses import dataclass, field
+
+import cg_request_args as rqa
+
+from ..utils import to_dict
+
+
+@dataclass
+class PromptEngineeringStepEnabledSetting:
+    """ """
+
+    name: "t.Literal['PROMPT_ENGINEERING_STEP_ENABLED']"
+    value: "t.Optional[bool]"
+
+    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("PROMPT_ENGINEERING_STEP_ENABLED"),
+                doc="",
+            ),
+            rqa.RequiredArgument(
+                "value",
+                rqa.Nullable(rqa.SimpleValue.bool),
+                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["PromptEngineeringStepEnabledSetting"],
+        d: t.Dict[str, t.Any],
+    ) -> "PromptEngineeringStepEnabledSetting":
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            name=parsed.name,
+            value=parsed.value,
+        )
+        res.raw_data = d
+        return res

{codegrade-16.1.77 → codegrade-16.1.80}/codegrade/models/site_setting_input.py

@@ -271,6 +271,9 @@ from .plagiarism_bulk_export_max_cases_setting import (
 from .plagiarism_pdf_export_enabled_setting import (
     PlagiarismPdfExportEnabledSetting,
 )
+from .prompt_engineering_step_enabled_setting import (
+    PromptEngineeringStepEnabledSetting,
+)
 from .quality_comments_in_code_editor_setting import (
     QualityCommentsInCodeEditorSetting,
 )
@@ -323,6 +326,9 @@ from .submissions_per_page_enabled_setting import (
 from .test_submission_copying_on_import_enabled_setting import (
     TestSubmissionCopyingOnImportEnabledSetting,
 )
+from .warning_for_missing_newline_disabled_setting import (
+    WarningForMissingNewlineDisabledSetting,
+)
 
 SiteSettingInput = t.Union[
     AutoTestMaxTimeCommandSetting,
@@ -463,11 +469,13 @@ SiteSettingInput = t.Union[
     StudentViewEnabledSetting,
     CodeEditorStartOnAssignmentDescriptionSetting,
     AiAssistantEnabledSetting,
+    PromptEngineeringStepEnabledSetting,
     FirstDayOfWeekFromLocaleSetting,
     InlineFeedbackOnQuizzesEnabledSetting,
     PearsonTryOutCodingQuestionEnabledSetting,
     IsPearsonSetting,
     QuizSingleQuestionModeHideRunButtonEnabledSetting,
+    WarningForMissingNewlineDisabledSetting,
 ]
 SiteSettingInputParser = rqa.Lazy(
     lambda: make_union(
@@ -609,10 +617,12 @@ SiteSettingInputParser = rqa.Lazy(
         ParserFor.make(StudentViewEnabledSetting),
         ParserFor.make(CodeEditorStartOnAssignmentDescriptionSetting),
         ParserFor.make(AiAssistantEnabledSetting),
+        ParserFor.make(PromptEngineeringStepEnabledSetting),
         ParserFor.make(FirstDayOfWeekFromLocaleSetting),
         ParserFor.make(InlineFeedbackOnQuizzesEnabledSetting),
         ParserFor.make(PearsonTryOutCodingQuestionEnabledSetting),
         ParserFor.make(IsPearsonSetting),
         ParserFor.make(QuizSingleQuestionModeHideRunButtonEnabledSetting),
+        ParserFor.make(WarningForMissingNewlineDisabledSetting),
     ),
 )

codegrade-16.1.80/codegrade/models/warning_for_missing_newline_disabled_setting.py

@@ -0,0 +1,57 @@
+"""The module that defines the ``WarningForMissingNewlineDisabledSetting`` model.
+
+SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
+"""
+
+import typing as t
+from dataclasses import dataclass, field
+
+import cg_request_args as rqa
+
+from ..utils import to_dict
+
+
+@dataclass
+class WarningForMissingNewlineDisabledSetting:
+    """ """
+
+    name: "t.Literal['WARNING_FOR_MISSING_NEWLINE_DISABLED']"
+    value: "t.Optional[bool]"
+
+    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("WARNING_FOR_MISSING_NEWLINE_DISABLED"),
+                doc="",
+            ),
+            rqa.RequiredArgument(
+                "value",
+                rqa.Nullable(rqa.SimpleValue.bool),
+                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["WarningForMissingNewlineDisabledSetting"],
+        d: t.Dict[str, t.Any],
+    ) -> "WarningForMissingNewlineDisabledSetting":
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            name=parsed.name,
+            value=parsed.value,
+        )
+        res.raw_data = d
+        return res

{codegrade-16.1.77 → codegrade-16.1.80}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codegrade"
-version = "16.1.77"
+version = "16.1.80"
 description = "A client library for accessing CodeGrade"
 license = "AGPL-3.0-only OR BSD-3-Clause-Clear"
 authors = []

{codegrade-16.1.77 → codegrade-16.1.80}/setup.py

@@ -21,7 +21,7 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'codegrade',
-    'version': '16.1.77',
+    'version': '16.1.80',
     'description': 'A client library for accessing CodeGrade',
     'long_description': '# CodeGrade API\n\nThis library makes it easier to use the CodeGrade API. Its API allows you to\nautomate your usage of CodeGrade. We are currently still busy documenting the\nentire API, but everything that is possible in the UI of CodeGrade is also\npossible through the API.\n## Installation\nYou can install the library through [pypi](https://pypi.org/), simply run\n`python3 -m pip install codegrade`. If you want to get a dev version with support\nfor the latest features, simply email [support@codegrade.com](mailto:support@codegrade.com)\nand we\'ll provide you with a dev version.\n## Usage\nFirst, create a client:\n\n```python\nimport codegrade\n\n# Don\'t store your password in your code!\nwith codegrade.login(\n    username=\'my-username\',\n    password=os.getenv(\'CG_PASSWORD\'),\n    tenant=\'My University\',\n) as client:\n    pass\n\n# Or supply information interactively.\nwith codegrade.login_from_cli() as client:\n    pass\n```\n\nNow call your endpoint and use your models:\n\n```python\nfrom codegrade.models import PatchCourseData\n\ncourses = client.course.get_all()\nfor course in courses:\n    client.course.patch(\n        PatchCourseData(name=course.name + \' (NEW)\'),\n        course_id=course.id,\n    )\n\n# Or, simply use dictionaries.\nfor course in courses:\n    client.course.patch(\n        {"name": course.name + \' (NEW)\'},\n        course_id=course.id,\n    )\n```\n\nFor the complete documentation go to\nhttps://python.api.codegrade.com.\n## Backwards compatibility\nCodeGrade is constantly upgrading its API, but we try to minimize backwards\nincompatible changes. We\'ll announce every backwards incompatible change in the\n[changelog](http://codegrade.com/changelog). A new version of the API\nclient is released with every release of CodeGrade, which is approximately every\nmonth. To upgrade simply run `pip install --upgrade codegrade`.\n## Supported python versions\nWe support python 3.6 and above, `pypy` is currently not tested but should work\njust fine.\n## License\nThe library is licensed under AGPL-3.0-only or BSD-3-Clause-Clear.',
     'author': 'None',