codegrade 16.1.47__tar.gz → 16.1.49__tar.gz

{codegrade-16.1.47 → codegrade-16.1.49}/PKG-INFO

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

{codegrade-16.1.47 → codegrade-16.1.49}/codegrade/client.py

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

{codegrade-16.1.47 → codegrade-16.1.49}/codegrade/models/__init__.py

@@ -255,6 +255,10 @@ from .custom_output_extra import CustomOutputExtra
 from .custom_output_input_as_json import CustomOutputInputAsJSON
 from .custom_output_log import CustomOutputLog
 from .custom_output_log_base import CustomOutputLogBase
+from .default_course_ta_role_setting import DefaultCourseTaRoleSetting
+from .default_course_teacher_role_setting import (
+    DefaultCourseTeacherRoleSetting,
+)
 from .deleted_comment_reply import DeletedCommentReply
 from .deletion_type import DeletionType
 from .directory_with_children import DirectoryWithChildren
@@ -336,6 +340,9 @@ from .health_information import HealthInformation
 from .hide_code_editor_output_viewer_with_only_quiz_steps_setting import (
     HideCodeEditorOutputViewerWithOnlyQuizStepsSetting,
 )
+from .hide_empty_rubric_row_description_setting import (
+    HideEmptyRubricRowDescriptionSetting,
+)
 from .ignore_handling import IgnoreHandling
 from .ignored_files_exception import IgnoredFilesException
 from .import_into_assignment_data import ImportIntoAssignmentData

{codegrade-16.1.47 → codegrade-16.1.49}/codegrade/models/all_site_settings.py

@@ -131,6 +131,16 @@ class AllSiteSettings(FrontendSiteSettings):
     lti_launch_data_logging: Maybe["bool"] = Nothing
     #: Whether or not pearson templates should be enabled.
     pearson_templates: Maybe["bool"] = Nothing
+    #: The teacher role to be used for teachers in new courses. Existing
+    #: courses will not be affected.
+    default_course_teacher_role: Maybe[
+        "t.Literal['Full Teacher', 'Non-Editing Teacher']"
+    ] = Nothing
+    #: The TA role to be used for TAs in new courses. Existing courses will not
+    #: be affected.
+    default_course_ta_role: Maybe[
+        "t.Literal['Full TA', 'Non-Editing TA']"
+    ] = Nothing
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -447,6 +457,22 @@ class AllSiteSettings(FrontendSiteSettings):
                     rqa.SimpleValue.bool,
                     doc="Whether or not pearson templates should be enabled.",
                 ),
+                rqa.OptionalArgument(
+                    "DEFAULT_COURSE_TEACHER_ROLE",
+                    rqa.StringEnum("Full Teacher", "Non-Editing Teacher"),
+                    doc=(
+                        "The teacher role to be used for teachers in new"
+                        " courses. Existing courses will not be affected."
+                    ),
+                ),
+                rqa.OptionalArgument(
+                    "DEFAULT_COURSE_TA_ROLE",
+                    rqa.StringEnum("Full TA", "Non-Editing TA"),
+                    doc=(
+                        "The TA role to be used for TAs in new courses."
+                        " Existing courses will not be affected."
+                    ),
+                ),
             )
         ).use_readable_describe(True)
     )
@@ -550,6 +576,12 @@ class AllSiteSettings(FrontendSiteSettings):
             self.lti_launch_data_logging
         )
         self.pearson_templates = maybe_from_nullable(self.pearson_templates)
+        self.default_course_teacher_role = maybe_from_nullable(
+            self.default_course_teacher_role
+        )
+        self.default_course_ta_role = maybe_from_nullable(
+            self.default_course_ta_role
+        )
 
     def to_dict(self) -> t.Dict[str, t.Any]:
         res: t.Dict[str, t.Any] = {}
@@ -877,6 +909,10 @@ class AllSiteSettings(FrontendSiteSettings):
             res["GRADE_VIEWER_AND_EDITOR_ON_SUBMISSION_ENABLED"] = to_dict(
                 self.grade_viewer_and_editor_on_submission_enabled.value
             )
+        if self.hide_empty_rubric_row_description.is_just:
+            res["HIDE_EMPTY_RUBRIC_ROW_DESCRIPTION"] = to_dict(
+                self.hide_empty_rubric_row_description.value
+            )
         if self.auto_test_heartbeat_interval.is_just:
             res["AUTO_TEST_HEARTBEAT_INTERVAL"] = to_dict(
                 self.auto_test_heartbeat_interval.value
@@ -1009,6 +1045,14 @@ class AllSiteSettings(FrontendSiteSettings):
             )
         if self.pearson_templates.is_just:
             res["PEARSON_TEMPLATES"] = to_dict(self.pearson_templates.value)
+        if self.default_course_teacher_role.is_just:
+            res["DEFAULT_COURSE_TEACHER_ROLE"] = to_dict(
+                self.default_course_teacher_role.value
+            )
+        if self.default_course_ta_role.is_just:
+            res["DEFAULT_COURSE_TA_ROLE"] = to_dict(
+                self.default_course_ta_role.value
+            )
         return res
 
     @classmethod
@@ -1103,6 +1147,7 @@ class AllSiteSettings(FrontendSiteSettings):
             hide_code_editor_output_viewer_with_only_quiz_steps=parsed.HIDE_CODE_EDITOR_OUTPUT_VIEWER_WITH_ONLY_QUIZ_STEPS,
             simple_submission_navigate_to_latest_editor_session=parsed.SIMPLE_SUBMISSION_NAVIGATE_TO_LATEST_EDITOR_SESSION,
             grade_viewer_and_editor_on_submission_enabled=parsed.GRADE_VIEWER_AND_EDITOR_ON_SUBMISSION_ENABLED,
+            hide_empty_rubric_row_description=parsed.HIDE_EMPTY_RUBRIC_ROW_DESCRIPTION,
             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,
@@ -1138,6 +1183,8 @@ class AllSiteSettings(FrontendSiteSettings):
             lti_first_launch_content_id_enabled=parsed.LTI_FIRST_LAUNCH_CONTENT_ID_ENABLED,
             lti_launch_data_logging=parsed.LTI_LAUNCH_DATA_LOGGING,
             pearson_templates=parsed.PEARSON_TEMPLATES,
+            default_course_teacher_role=parsed.DEFAULT_COURSE_TEACHER_ROLE,
+            default_course_ta_role=parsed.DEFAULT_COURSE_TA_ROLE,
         )
         res.raw_data = d
         return res

{codegrade-16.1.47 → codegrade-16.1.49}/codegrade/models/course_perm_map.py

@@ -280,6 +280,9 @@ class CoursePermMap:
     #: Users with this permission can create test submissions in the
     #: assignments of this course.
     can_create_test_submissions: "bool"
+    #: Users with this permission are allowed to see the details of Pearson
+    #: templates in a course (context).
+    can_view_pearson_context_templates: "bool"
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -1006,6 +1009,14 @@ class CoursePermMap:
                     " the assignments of this course."
                 ),
             ),
+            rqa.RequiredArgument(
+                "can_view_pearson_context_templates",
+                rqa.SimpleValue.bool,
+                doc=(
+                    "Users with this permission are allowed to see the details"
+                    " of Pearson templates in a course (context)."
+                ),
+            ),
         ).use_readable_describe(True)
     )
 
@@ -1174,6 +1185,9 @@ class CoursePermMap:
             "can_create_test_submissions": to_dict(
                 self.can_create_test_submissions
             ),
+            "can_view_pearson_context_templates": to_dict(
+                self.can_view_pearson_context_templates
+            ),
         }
         return res
 
@@ -1269,6 +1283,7 @@ class CoursePermMap:
             can_view_own_course_section_members=parsed.can_view_own_course_section_members,
             can_view_all_assignment_timeframes=parsed.can_view_all_assignment_timeframes,
             can_create_test_submissions=parsed.can_create_test_submissions,
+            can_view_pearson_context_templates=parsed.can_view_pearson_context_templates,
         )
         res.raw_data = d
         return res

{codegrade-16.1.47 → codegrade-16.1.49}/codegrade/models/course_permission.py

@@ -105,3 +105,4 @@ class CoursePermission(str, Enum):
     can_view_own_course_section_members = "can_view_own_course_section_members"
     can_view_all_assignment_timeframes = "can_view_all_assignment_timeframes"
     can_create_test_submissions = "can_create_test_submissions"
+    can_view_pearson_context_templates = "can_view_pearson_context_templates"

codegrade-16.1.49/codegrade/models/default_course_ta_role_setting.py

@@ -0,0 +1,56 @@
+"""The module that defines the ``DefaultCourseTaRoleSetting`` 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 DefaultCourseTaRoleSetting:
+    """ """
+
+    name: "t.Literal['DEFAULT_COURSE_TA_ROLE']"
+    value: "t.Optional[t.Literal['Full TA', 'Non-Editing TA']]"
+
+    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("DEFAULT_COURSE_TA_ROLE"),
+                doc="",
+            ),
+            rqa.RequiredArgument(
+                "value",
+                rqa.Nullable(rqa.StringEnum("Full TA", "Non-Editing TA")),
+                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["DefaultCourseTaRoleSetting"], d: t.Dict[str, t.Any]
+    ) -> "DefaultCourseTaRoleSetting":
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            name=parsed.name,
+            value=parsed.value,
+        )
+        res.raw_data = d
+        return res

codegrade-16.1.49/codegrade/models/default_course_teacher_role_setting.py

@@ -0,0 +1,58 @@
+"""The module that defines the ``DefaultCourseTeacherRoleSetting`` 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 DefaultCourseTeacherRoleSetting:
+    """ """
+
+    name: "t.Literal['DEFAULT_COURSE_TEACHER_ROLE']"
+    value: "t.Optional[t.Literal['Full Teacher', 'Non-Editing Teacher']]"
+
+    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("DEFAULT_COURSE_TEACHER_ROLE"),
+                doc="",
+            ),
+            rqa.RequiredArgument(
+                "value",
+                rqa.Nullable(
+                    rqa.StringEnum("Full Teacher", "Non-Editing Teacher")
+                ),
+                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["DefaultCourseTeacherRoleSetting"], d: t.Dict[str, t.Any]
+    ) -> "DefaultCourseTeacherRoleSetting":
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            name=parsed.name,
+            value=parsed.value,
+        )
+        res.raw_data = d
+        return res

{codegrade-16.1.47 → codegrade-16.1.49}/codegrade/models/frontend_site_settings.py

@@ -299,6 +299,9 @@ class FrontendSiteSettings:
     #: submission in the rubric if we have one, but only in readonly mode.
     #: Teachers cannot editor the rubric.
     grade_viewer_and_editor_on_submission_enabled: Maybe["bool"] = Nothing
+    #: Whether we hide the rubric row description space in the rubric viewer if
+    #: the description is empty.
+    hide_empty_rubric_row_description: Maybe["bool"] = Nothing
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -999,6 +1002,14 @@ class FrontendSiteSettings:
                     " Teachers cannot editor the rubric."
                 ),
             ),
+            rqa.OptionalArgument(
+                "HIDE_EMPTY_RUBRIC_ROW_DESCRIPTION",
+                rqa.SimpleValue.bool,
+                doc=(
+                    "Whether we hide the rubric row description space in the"
+                    " rubric viewer if the description is empty."
+                ),
+            ),
         ).use_readable_describe(True)
     )
 
@@ -1249,6 +1260,9 @@ class FrontendSiteSettings:
                 self.grade_viewer_and_editor_on_submission_enabled
             )
         )
+        self.hide_empty_rubric_row_description = maybe_from_nullable(
+            self.hide_empty_rubric_row_description
+        )
 
     def to_dict(self) -> t.Dict[str, t.Any]:
         res: t.Dict[str, t.Any] = {}
@@ -1576,6 +1590,10 @@ class FrontendSiteSettings:
             res["GRADE_VIEWER_AND_EDITOR_ON_SUBMISSION_ENABLED"] = to_dict(
                 self.grade_viewer_and_editor_on_submission_enabled.value
             )
+        if self.hide_empty_rubric_row_description.is_just:
+            res["HIDE_EMPTY_RUBRIC_ROW_DESCRIPTION"] = to_dict(
+                self.hide_empty_rubric_row_description.value
+            )
         return res
 
     @classmethod
@@ -1670,6 +1688,7 @@ class FrontendSiteSettings:
             hide_code_editor_output_viewer_with_only_quiz_steps=parsed.HIDE_CODE_EDITOR_OUTPUT_VIEWER_WITH_ONLY_QUIZ_STEPS,
             simple_submission_navigate_to_latest_editor_session=parsed.SIMPLE_SUBMISSION_NAVIGATE_TO_LATEST_EDITOR_SESSION,
             grade_viewer_and_editor_on_submission_enabled=parsed.GRADE_VIEWER_AND_EDITOR_ON_SUBMISSION_ENABLED,
+            hide_empty_rubric_row_description=parsed.HIDE_EMPTY_RUBRIC_ROW_DESCRIPTION,
         )
         res.raw_data = d
         return res

codegrade-16.1.49/codegrade/models/hide_empty_rubric_row_description_setting.py

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

{codegrade-16.1.47 → codegrade-16.1.49}/codegrade/models/site_setting_input.py

@@ -103,6 +103,10 @@ from .course_gradebook_render_warning_size_setting import (
 from .course_register_enabled_setting import CourseRegisterEnabledSetting
 from .csv_large_file_limit_setting import CsvLargeFileLimitSetting
 from .csv_too_many_errors_limit_setting import CsvTooManyErrorsLimitSetting
+from .default_course_ta_role_setting import DefaultCourseTaRoleSetting
+from .default_course_teacher_role_setting import (
+    DefaultCourseTeacherRoleSetting,
+)
 from .editor_enabled_for_teachers_setting import (
     EditorEnabledForTeachersSetting,
 )
@@ -125,6 +129,9 @@ from .groups_enabled_setting import GroupsEnabledSetting
 from .hide_code_editor_output_viewer_with_only_quiz_steps_setting import (
     HideCodeEditorOutputViewerWithOnlyQuizStepsSetting,
 )
+from .hide_empty_rubric_row_description_setting import (
+    HideEmptyRubricRowDescriptionSetting,
+)
 from .incremental_rubric_submission_enabled_setting import (
     IncrementalRubricSubmissionEnabledSetting,
 )
@@ -392,6 +399,9 @@ SiteSettingInput = t.Union[
     PearsonTemplatesSetting,
     SimpleSubmissionNavigateToLatestEditorSessionSetting,
     GradeViewerAndEditorOnSubmissionEnabledSetting,
+    HideEmptyRubricRowDescriptionSetting,
+    DefaultCourseTeacherRoleSetting,
+    DefaultCourseTaRoleSetting,
 ]
 SiteSettingInputParser = rqa.Lazy(
     lambda: make_union(
@@ -515,5 +525,8 @@ SiteSettingInputParser = rqa.Lazy(
         ParserFor.make(PearsonTemplatesSetting),
         ParserFor.make(SimpleSubmissionNavigateToLatestEditorSessionSetting),
         ParserFor.make(GradeViewerAndEditorOnSubmissionEnabledSetting),
+        ParserFor.make(HideEmptyRubricRowDescriptionSetting),
+        ParserFor.make(DefaultCourseTeacherRoleSetting),
+        ParserFor.make(DefaultCourseTaRoleSetting),
     ),
 )

{codegrade-16.1.47 → codegrade-16.1.49}/pyproject.toml

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

{codegrade-16.1.47 → codegrade-16.1.49}/setup.py

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