codegrade 16.1.75__tar.gz → 16.1.77__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codegrade
-Version: 16.1.75
+Version: 16.1.77
 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.75 → codegrade-16.1.77}/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.75"
+__version__ = "16.1.77"
 
 
 @wraps(AuthenticatedClient.get)

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

@@ -538,7 +538,7 @@ class Client(_BaseClient):
         return httpx.Client(
             base_url=self.base_url,
             headers={
-                "User-Agent": "CodeGradeAPI/16.1.75",
+                "User-Agent": "CodeGradeAPI/16.1.77",
             },
             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.75",
+                "User-Agent": "CodeGradeAPI/16.1.77",
             },
             follow_redirects=True,
         )

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

@@ -397,6 +397,7 @@ from .io_test_step_log_base import IOTestStepLogBase
 from .is_admin_permission_enabled_setting import (
     IsAdminPermissionEnabledSetting,
 )
+from .is_pearson_setting import IsPearsonSetting
 from .job import Job
 from .json_create_auto_test import JsonCreateAutoTest
 from .json_create_tenant import JsonCreateTenant
@@ -611,6 +612,9 @@ from .quality_comments_in_code_editor_setting import (
 )
 from .quality_test_log import QualityTestLog
 from .quality_test_log_base import QualityTestLogBase
+from .quiz_single_question_mode_hide_run_button_enabled_setting import (
+    QuizSingleQuestionModeHideRunButtonEnabledSetting,
+)
 from .register_enabled_setting import RegisterEnabledSetting
 from .register_user_data import RegisterUserData
 from .register_user_with_link_course_data import RegisterUserWithLinkCourseData

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

@@ -155,6 +155,10 @@ class AllSiteSettings(FrontendSiteSettings):
     always_update_pii_with_lti: Maybe["bool"] = Nothing
     #: Should we sync teachers to Hubspot.
     hubspot_syncing_enabled: Maybe["bool"] = Nothing
+    #: Whether we are running Codegrade for Pearson specifically, flag aligns
+    #: all the smallest adjustments needed that cannot be made into an actual
+    #: feature.
+    is_pearson: Maybe["bool"] = Nothing
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -522,6 +526,16 @@ class AllSiteSettings(FrontendSiteSettings):
                     rqa.SimpleValue.bool,
                     doc="Should we sync teachers to Hubspot.",
                 ),
+                rqa.OptionalArgument(
+                    "IS_PEARSON",
+                    rqa.SimpleValue.bool,
+                    doc=(
+                        "Whether we are running Codegrade for Pearson"
+                        " specifically, flag aligns all the smallest"
+                        " adjustments needed that cannot be made into an"
+                        " actual feature."
+                    ),
+                ),
             )
         ).use_readable_describe(True)
     )
@@ -643,6 +657,7 @@ class AllSiteSettings(FrontendSiteSettings):
         self.hubspot_syncing_enabled = maybe_from_nullable(
             self.hubspot_syncing_enabled
         )
+        self.is_pearson = maybe_from_nullable(self.is_pearson)
 
     def to_dict(self) -> t.Dict[str, t.Any]:
         res: t.Dict[str, t.Any] = {}
@@ -1032,6 +1047,10 @@ class AllSiteSettings(FrontendSiteSettings):
             res["PEARSON_TRY_OUT_CODING_QUESTION_ENABLED"] = to_dict(
                 self.pearson_try_out_coding_question_enabled.value
             )
+        if self.quiz_single_question_mode_hide_run_button_enabled.is_just:
+            res["QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_ENABLED"] = to_dict(
+                self.quiz_single_question_mode_hide_run_button_enabled.value
+            )
         if self.auto_test_heartbeat_interval.is_just:
             res["AUTO_TEST_HEARTBEAT_INTERVAL"] = to_dict(
                 self.auto_test_heartbeat_interval.value
@@ -1188,6 +1207,8 @@ class AllSiteSettings(FrontendSiteSettings):
             res["HUBSPOT_SYNCING_ENABLED"] = to_dict(
                 self.hubspot_syncing_enabled.value
             )
+        if self.is_pearson.is_just:
+            res["IS_PEARSON"] = to_dict(self.is_pearson.value)
         return res
 
     @classmethod
@@ -1297,6 +1318,7 @@ class AllSiteSettings(FrontendSiteSettings):
             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,
             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,
@@ -1338,6 +1360,7 @@ class AllSiteSettings(FrontendSiteSettings):
             name_and_email_from_nrps_only=parsed.NAME_AND_EMAIL_FROM_NRPS_ONLY,
             always_update_pii_with_lti=parsed.ALWAYS_UPDATE_PII_WITH_LTI,
             hubspot_syncing_enabled=parsed.HUBSPOT_SYNCING_ENABLED,
+            is_pearson=parsed.IS_PEARSON,
         )
         res.raw_data = d
         return res

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

@@ -348,6 +348,10 @@ class FrontendSiteSettings:
     inline_feedback_on_quizzes_enabled: Maybe["bool"] = Nothing
     #: Whether to enable the "Try out" functionality in Pearson templates.
     pearson_try_out_coding_question_enabled: Maybe["bool"] = Nothing
+    #: Whether to hide the "▶️ Run" button in the editor sidebar when an
+    #: assignment contains only quizzes with the "Run single questions" feature
+    #: enabled.
+    quiz_single_question_mode_hide_run_button_enabled: Maybe["bool"] = Nothing
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -1180,6 +1184,15 @@ class FrontendSiteSettings:
                     " templates."
                 ),
             ),
+            rqa.OptionalArgument(
+                "QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_ENABLED",
+                rqa.SimpleValue.bool,
+                doc=(
+                    'Whether to hide the "▶️ Run" button in the editor sidebar'
+                    ' when an assignment contains only quizzes with the "Run'
+                    ' single questions" feature enabled.'
+                ),
+            ),
         ).use_readable_describe(True)
     )
 
@@ -1475,6 +1488,11 @@ class FrontendSiteSettings:
         self.pearson_try_out_coding_question_enabled = maybe_from_nullable(
             self.pearson_try_out_coding_question_enabled
         )
+        self.quiz_single_question_mode_hide_run_button_enabled = (
+            maybe_from_nullable(
+                self.quiz_single_question_mode_hide_run_button_enabled
+            )
+        )
 
     def to_dict(self) -> t.Dict[str, t.Any]:
         res: t.Dict[str, t.Any] = {}
@@ -1864,6 +1882,10 @@ class FrontendSiteSettings:
             res["PEARSON_TRY_OUT_CODING_QUESTION_ENABLED"] = to_dict(
                 self.pearson_try_out_coding_question_enabled.value
             )
+        if self.quiz_single_question_mode_hide_run_button_enabled.is_just:
+            res["QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_ENABLED"] = to_dict(
+                self.quiz_single_question_mode_hide_run_button_enabled.value
+            )
         return res
 
     @classmethod
@@ -1973,6 +1995,7 @@ class FrontendSiteSettings:
             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,
         )
         res.raw_data = d
         return res

codegrade-16.1.77/codegrade/models/is_pearson_setting.py

@@ -0,0 +1,56 @@
+"""The module that defines the ``IsPearsonSetting`` 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 IsPearsonSetting:
+    """ """
+
+    name: "t.Literal['IS_PEARSON']"
+    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("IS_PEARSON"),
+                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["IsPearsonSetting"], d: t.Dict[str, t.Any]
+    ) -> "IsPearsonSetting":
+        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/models/quiz_single_question_mode_hide_run_button_enabled_setting.py

@@ -0,0 +1,59 @@
+"""The module that defines the ``QuizSingleQuestionModeHideRunButtonEnabledSetting`` 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 QuizSingleQuestionModeHideRunButtonEnabledSetting:
+    """ """
+
+    name: "t.Literal['QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_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(
+                    "QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_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["QuizSingleQuestionModeHideRunButtonEnabledSetting"],
+        d: t.Dict[str, t.Any],
+    ) -> "QuizSingleQuestionModeHideRunButtonEnabledSetting":
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            name=parsed.name,
+            value=parsed.value,
+        )
+        res.raw_data = d
+        return res

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

@@ -165,6 +165,7 @@ from .inline_rubric_viewer_enabled_setting import (
 from .is_admin_permission_enabled_setting import (
     IsAdminPermissionEnabledSetting,
 )
+from .is_pearson_setting import IsPearsonSetting
 from .jwt_access_token_expires_setting import JwtAccessTokenExpiresSetting
 from .linters_enabled_setting import LintersEnabledSetting
 from .login_token_before_time_setting import LoginTokenBeforeTimeSetting
@@ -273,6 +274,9 @@ from .plagiarism_pdf_export_enabled_setting import (
 from .quality_comments_in_code_editor_setting import (
     QualityCommentsInCodeEditorSetting,
 )
+from .quiz_single_question_mode_hide_run_button_enabled_setting import (
+    QuizSingleQuestionModeHideRunButtonEnabledSetting,
+)
 from .register_enabled_setting import RegisterEnabledSetting
 from .release_message_max_time_setting import ReleaseMessageMaxTimeSetting
 from .render_html_enabled_setting import RenderHtmlEnabledSetting
@@ -462,6 +466,8 @@ SiteSettingInput = t.Union[
     FirstDayOfWeekFromLocaleSetting,
     InlineFeedbackOnQuizzesEnabledSetting,
     PearsonTryOutCodingQuestionEnabledSetting,
+    IsPearsonSetting,
+    QuizSingleQuestionModeHideRunButtonEnabledSetting,
 ]
 SiteSettingInputParser = rqa.Lazy(
     lambda: make_union(
@@ -606,5 +612,7 @@ SiteSettingInputParser = rqa.Lazy(
         ParserFor.make(FirstDayOfWeekFromLocaleSetting),
         ParserFor.make(InlineFeedbackOnQuizzesEnabledSetting),
         ParserFor.make(PearsonTryOutCodingQuestionEnabledSetting),
+        ParserFor.make(IsPearsonSetting),
+        ParserFor.make(QuizSingleQuestionModeHideRunButtonEnabledSetting),
     ),
 )

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

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

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

@@ -21,7 +21,7 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'codegrade',
-    'version': '16.1.75',
+    'version': '16.1.77',
     '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',