codegrade 16.1.84__tar.gz → 16.1.86__tar.gz

{codegrade-16.1.84 → codegrade-16.1.86}/PKG-INFO

@@ -1,12 +1,11 @@
 Metadata-Version: 2.1
 Name: codegrade
-Version: 16.1.84
+Version: 16.1.86
 Summary: A client library for accessing CodeGrade
 License: AGPL-3.0-only OR BSD-3-Clause-Clear
-Requires-Python: >=3.8.0,<4.0
+Requires-Python: >=3.9.0,<4.0
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11

{codegrade-16.1.84 → codegrade-16.1.86}/cg_request_args/_convert.py

@@ -434,3 +434,9 @@ def _convert_set(ctx: ConvertCtx) -> Parser:
     return Set(
         ctx.update_type(ctx.typ.__args__[0]).convert(),
     ).use_readable_describe(ctx.readable)
+
+
+@as_converter(lambda x: x.typ is object)
+def _convert_object(ctx: ConvertCtx) -> Parser:
+    ctx.assert_not_query()
+    return AnyValue

{codegrade-16.1.84 → codegrade-16.1.86}/codegrade/__init__.py

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

{codegrade-16.1.84 → codegrade-16.1.86}/codegrade/client.py

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

{codegrade-16.1.84 → codegrade-16.1.86}/codegrade/models/__init__.py

@@ -72,6 +72,7 @@ from .assignment_state_enum import AssignmentStateEnum
 from .assignment_submission_mode import AssignmentSubmissionMode
 from .assignment_template import AssignmentTemplate
 from .assignment_timeframes import AssignmentTimeframes
+from .assistant_tools_enabled_setting import AssistantToolsEnabledSetting
 from .at_image_caching_enabled_setting import AtImageCachingEnabledSetting
 from .auto_test import AutoTest
 from .auto_test_capture_points_message_setting import (
@@ -413,6 +414,9 @@ from .junit_test_log_base import JunitTestLogBase
 from .jupyter_notebook_editor_enabled_setting import (
     JupyterNotebookEditorEnabledSetting,
 )
+from .jupyter_notebook_running_enabled_setting import (
+    JupyterNotebookRunningEnabledSetting,
+)
 from .jwt_access_token_expires_setting import JwtAccessTokenExpiresSetting
 from .legacy_features import LegacyFeatures
 from .line_range import LineRange

{codegrade-16.1.84 → codegrade-16.1.86}/codegrade/models/all_site_settings.py

@@ -874,6 +874,10 @@ class AllSiteSettings(FrontendSiteSettings):
             res["AI_ASSISTANT_ENABLED"] = to_dict(
                 self.ai_assistant_enabled.value
             )
+        if self.assistant_tools_enabled.is_just:
+            res["ASSISTANT_TOOLS_ENABLED"] = to_dict(
+                self.assistant_tools_enabled.value
+            )
         if self.prompt_engineering_step_enabled.is_just:
             res["PROMPT_ENGINEERING_STEP_ENABLED"] = to_dict(
                 self.prompt_engineering_step_enabled.value
@@ -902,6 +906,10 @@ class AllSiteSettings(FrontendSiteSettings):
             res["JUPYTER_NOTEBOOK_EDITOR_ENABLED"] = to_dict(
                 self.jupyter_notebook_editor_enabled.value
             )
+        if self.jupyter_notebook_running_enabled.is_just:
+            res["JUPYTER_NOTEBOOK_RUNNING_ENABLED"] = to_dict(
+                self.jupyter_notebook_running_enabled.value
+            )
         if self.auto_test_heartbeat_interval.is_just:
             res["AUTO_TEST_HEARTBEAT_INTERVAL"] = to_dict(
                 self.auto_test_heartbeat_interval.value
@@ -1166,6 +1174,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,
+            assistant_tools_enabled=parsed.ASSISTANT_TOOLS_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,
@@ -1173,6 +1182,7 @@ class AllSiteSettings(FrontendSiteSettings):
             quiz_single_question_mode_hide_run_button_enabled=parsed.QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_ENABLED,
             warning_for_missing_newline_enabled=parsed.WARNING_FOR_MISSING_NEWLINE_ENABLED,
             jupyter_notebook_editor_enabled=parsed.JUPYTER_NOTEBOOK_EDITOR_ENABLED,
+            jupyter_notebook_running_enabled=parsed.JUPYTER_NOTEBOOK_RUNNING_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,

codegrade-16.1.86/codegrade/models/assistant_tools_enabled_setting.py

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

{codegrade-16.1.84 → codegrade-16.1.86}/codegrade/models/frontend_site_settings.py

@@ -339,6 +339,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
+    #: 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
     #: 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
@@ -362,6 +365,10 @@ class FrontendSiteSettings:
     #: after disabling this feature, existing Jupyter Notebooks will still
     #: continue to use the Jupyter Notebook editor.
     jupyter_notebook_editor_enabled: Maybe["bool"] = Nothing
+    #: Whether the Jupyter Notebook can be run in the Code Editor. Note:
+    #: Disabling this feature does not prevent Jupyter Notebooks from being
+    #: viewed. For that, see the JUPYTER_NOTEBOOK_EDITOR_ENABLED site setting.
+    jupyter_notebook_running_enabled: Maybe["bool"] = Nothing
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -858,6 +865,11 @@ class FrontendSiteSettings:
                 rqa.SimpleValue.bool,
                 doc="The main feature flag for all the AI assistant capabilities in codegrade, whether we enable the ai assistant to be inside the app.",
             ),
+            rqa.OptionalArgument(
+                "ASSISTANT_TOOLS_ENABLED",
+                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(
                 "PROMPT_ENGINEERING_STEP_ENABLED",
                 rqa.SimpleValue.bool,
@@ -893,6 +905,11 @@ class FrontendSiteSettings:
                 rqa.SimpleValue.bool,
                 doc="Whether the Jupyter Notebook editor is enabled in the Code Editor. Note: after disabling this feature, existing Jupyter Notebooks will still continue to use the Jupyter Notebook editor.",
             ),
+            rqa.OptionalArgument(
+                "JUPYTER_NOTEBOOK_RUNNING_ENABLED",
+                rqa.SimpleValue.bool,
+                doc="Whether the Jupyter Notebook can be run in the Code Editor. Note: Disabling this feature does not prevent Jupyter Notebooks from being viewed. For that, see the JUPYTER_NOTEBOOK_EDITOR_ENABLED site setting.",
+            ),
         ).use_readable_describe(True)
     )
 
@@ -1179,6 +1196,9 @@ class FrontendSiteSettings:
         self.ai_assistant_enabled = maybe_from_nullable(
             self.ai_assistant_enabled
         )
+        self.assistant_tools_enabled = maybe_from_nullable(
+            self.assistant_tools_enabled
+        )
         self.prompt_engineering_step_enabled = maybe_from_nullable(
             self.prompt_engineering_step_enabled
         )
@@ -1202,6 +1222,9 @@ class FrontendSiteSettings:
         self.jupyter_notebook_editor_enabled = maybe_from_nullable(
             self.jupyter_notebook_editor_enabled
         )
+        self.jupyter_notebook_running_enabled = maybe_from_nullable(
+            self.jupyter_notebook_running_enabled
+        )
 
     def to_dict(self) -> t.Dict[str, t.Any]:
         res: t.Dict[str, t.Any] = {}
@@ -1579,6 +1602,10 @@ class FrontendSiteSettings:
             res["AI_ASSISTANT_ENABLED"] = to_dict(
                 self.ai_assistant_enabled.value
             )
+        if self.assistant_tools_enabled.is_just:
+            res["ASSISTANT_TOOLS_ENABLED"] = to_dict(
+                self.assistant_tools_enabled.value
+            )
         if self.prompt_engineering_step_enabled.is_just:
             res["PROMPT_ENGINEERING_STEP_ENABLED"] = to_dict(
                 self.prompt_engineering_step_enabled.value
@@ -1607,6 +1634,10 @@ class FrontendSiteSettings:
             res["JUPYTER_NOTEBOOK_EDITOR_ENABLED"] = to_dict(
                 self.jupyter_notebook_editor_enabled.value
             )
+        if self.jupyter_notebook_running_enabled.is_just:
+            res["JUPYTER_NOTEBOOK_RUNNING_ENABLED"] = to_dict(
+                self.jupyter_notebook_running_enabled.value
+            )
         return res
 
     @classmethod
@@ -1713,6 +1744,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,
+            assistant_tools_enabled=parsed.ASSISTANT_TOOLS_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,
@@ -1720,6 +1752,7 @@ class FrontendSiteSettings:
             quiz_single_question_mode_hide_run_button_enabled=parsed.QUIZ_SINGLE_QUESTION_MODE_HIDE_RUN_BUTTON_ENABLED,
             warning_for_missing_newline_enabled=parsed.WARNING_FOR_MISSING_NEWLINE_ENABLED,
             jupyter_notebook_editor_enabled=parsed.JUPYTER_NOTEBOOK_EDITOR_ENABLED,
+            jupyter_notebook_running_enabled=parsed.JUPYTER_NOTEBOOK_RUNNING_ENABLED,
         )
         res.raw_data = d
         return res

codegrade-16.1.86/codegrade/models/jupyter_notebook_running_enabled_setting.py

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

{codegrade-16.1.84 → codegrade-16.1.86}/codegrade/models/site_setting_input.py

@@ -41,6 +41,7 @@ from .assignment_percentage_decimals_setting import (
     AssignmentPercentageDecimalsSetting,
 )
 from .assignment_point_decimals_setting import AssignmentPointDecimalsSetting
+from .assistant_tools_enabled_setting import AssistantToolsEnabledSetting
 from .at_image_caching_enabled_setting import AtImageCachingEnabledSetting
 from .auto_test_capture_points_message_setting import (
     AutoTestCapturePointsMessageSetting,
@@ -169,6 +170,9 @@ from .is_pearson_setting import IsPearsonSetting
 from .jupyter_notebook_editor_enabled_setting import (
     JupyterNotebookEditorEnabledSetting,
 )
+from .jupyter_notebook_running_enabled_setting import (
+    JupyterNotebookRunningEnabledSetting,
+)
 from .jwt_access_token_expires_setting import JwtAccessTokenExpiresSetting
 from .linters_enabled_setting import LintersEnabledSetting
 from .login_token_before_time_setting import LoginTokenBeforeTimeSetting
@@ -472,6 +476,7 @@ SiteSettingInput = t.Union[
     StudentViewEnabledSetting,
     CodeEditorStartOnAssignmentDescriptionSetting,
     AiAssistantEnabledSetting,
+    AssistantToolsEnabledSetting,
     PromptEngineeringStepEnabledSetting,
     FirstDayOfWeekFromLocaleSetting,
     InlineFeedbackOnQuizzesEnabledSetting,
@@ -480,6 +485,7 @@ SiteSettingInput = t.Union[
     QuizSingleQuestionModeHideRunButtonEnabledSetting,
     WarningForMissingNewlineEnabledSetting,
     JupyterNotebookEditorEnabledSetting,
+    JupyterNotebookRunningEnabledSetting,
 ]
 SiteSettingInputParser = rqa.Lazy(
     lambda: make_union(
@@ -621,6 +627,7 @@ SiteSettingInputParser = rqa.Lazy(
         ParserFor.make(StudentViewEnabledSetting),
         ParserFor.make(CodeEditorStartOnAssignmentDescriptionSetting),
         ParserFor.make(AiAssistantEnabledSetting),
+        ParserFor.make(AssistantToolsEnabledSetting),
         ParserFor.make(PromptEngineeringStepEnabledSetting),
         ParserFor.make(FirstDayOfWeekFromLocaleSetting),
         ParserFor.make(InlineFeedbackOnQuizzesEnabledSetting),
@@ -629,5 +636,6 @@ SiteSettingInputParser = rqa.Lazy(
         ParserFor.make(QuizSingleQuestionModeHideRunButtonEnabledSetting),
         ParserFor.make(WarningForMissingNewlineEnabledSetting),
         ParserFor.make(JupyterNotebookEditorEnabledSetting),
+        ParserFor.make(JupyterNotebookRunningEnabledSetting),
     ),
 )

{codegrade-16.1.84 → codegrade-16.1.86}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codegrade"
-version = "16.1.84"
+version = "16.1.86"
 description = "A client library for accessing CodeGrade"
 license = "AGPL-3.0-only OR BSD-3-Clause-Clear"
 authors = []
@@ -15,7 +15,7 @@ include = ["CHANGELOG.md", "py.typed"]
 documentation = "https://python.api.codegrade.com"
 
 [tool.poetry.dependencies]
-python = ">=3.8.0,<4.0"
+python = ">=3.9.0,<4.0"
 httpx = ">=0.19.0, <1.0.0"
 structlog = "^20.1.0"
 validate-email = "^1.3"
@@ -27,7 +27,7 @@ mypy = "^1.3.0"
 sphinx = "^6.2.1"
 sphinx-autodoc-typehints = "^1.23.0"
 m2r2 = "^0.3.1"
-setuptools = "^74.1.2"
+setuptools = "^80.7.1"
 # Is needed because of https://github.com/CrossNox/m2r2/issues/40 or
 # https://github.com/miyakogi/m2r/issues/66
 mistune = '<2.0.0'

{codegrade-16.1.84 → codegrade-16.1.86}/setup.py

@@ -21,7 +21,7 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'codegrade',
-    'version': '16.1.84',
+    'version': '16.1.86',
     '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',
@@ -32,7 +32,7 @@ setup_kwargs = {
     'packages': packages,
     'package_data': package_data,
     'install_requires': install_requires,
-    'python_requires': '>=3.8.0,<4.0',
+    'python_requires': '>=3.9.0,<4.0',
 }