codegrade 16.1.76__tar.gz → 16.1.78__tar.gz

{codegrade-16.1.76 → codegrade-16.1.78}/PKG-INFO

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

{codegrade-16.1.76 → codegrade-16.1.78}/codegrade/client.py

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

{codegrade-16.1.76 → codegrade-16.1.78}/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
@@ -599,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

{codegrade-16.1.76 → codegrade-16.1.78}/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] = {}
@@ -1020,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
@@ -1192,6 +1211,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
@@ -1298,6 +1319,7 @@ 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,
@@ -1343,6 +1365,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.76 → codegrade-16.1.78}/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.
@@ -1159,6 +1162,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,
@@ -1479,6 +1491,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
         )
@@ -1870,6 +1885,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
@@ -1992,6 +2011,7 @@ 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,

codegrade-16.1.78/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.78/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.76 → codegrade-16.1.78}/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
@@ -270,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,
 )
@@ -462,9 +466,11 @@ SiteSettingInput = t.Union[
     StudentViewEnabledSetting,
     CodeEditorStartOnAssignmentDescriptionSetting,
     AiAssistantEnabledSetting,
+    PromptEngineeringStepEnabledSetting,
     FirstDayOfWeekFromLocaleSetting,
     InlineFeedbackOnQuizzesEnabledSetting,
     PearsonTryOutCodingQuestionEnabledSetting,
+    IsPearsonSetting,
     QuizSingleQuestionModeHideRunButtonEnabledSetting,
 ]
 SiteSettingInputParser = rqa.Lazy(
@@ -607,9 +613,11 @@ 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),
     ),
 )

{codegrade-16.1.76 → codegrade-16.1.78}/pyproject.toml

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

{codegrade-16.1.76 → codegrade-16.1.78}/setup.py

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