codegrade 16.1.39__tar.gz → 16.1.40__tar.gz

{codegrade-16.1.39 → codegrade-16.1.40}/PKG-INFO

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

{codegrade-16.1.39 → codegrade-16.1.40}/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.39"
+__version__ = "16.1.40"
 
 
 @wraps(AuthenticatedClient.get)

{codegrade-16.1.39 → codegrade-16.1.40}/codegrade/client.py

@@ -526,7 +526,7 @@ class Client(_BaseClient):
         return httpx.Client(
             base_url=self.base_url,
             headers={
-                "User-Agent": "CodeGradeAPI/16.1.39",
+                "User-Agent": "CodeGradeAPI/16.1.40",
             },
         )
 
@@ -545,7 +545,7 @@ class AuthenticatedClient(_BaseClient):
             base_url=self.base_url,
             headers={
                 "Authorization": f"Bearer {self.token}",
-                "User-Agent": "CodeGradeAPI/16.1.39",
+                "User-Agent": "CodeGradeAPI/16.1.40",
             },
         )
 

{codegrade-16.1.39 → codegrade-16.1.40}/codegrade/models/__init__.py

@@ -397,6 +397,7 @@ from .lti_enabled_setting import LtiEnabledSetting
 from .lti_first_launch_content_id_enabled_setting import (
     LtiFirstLaunchContentIdEnabledSetting,
 )
+from .lti_launch_data_logging_setting import LtiLaunchDataLoggingSetting
 from .lti_lock_date_copying_enabled_setting import (
     LtiLockDateCopyingEnabledSetting,
 )

{codegrade-16.1.39 → codegrade-16.1.40}/codegrade/models/all_site_settings.py

@@ -125,6 +125,10 @@ class AllSiteSettings(FrontendSiteSettings):
     #: then use to import an item from the community library. This feature
     #: enables that we check for this content id in the launch parameters.
     lti_first_launch_content_id_enabled: Maybe["bool"] = Nothing
+    #: Enable logging of LTI launch data. NEVER ENABLE THIS SITE-WIDE, only for
+    #: a single tenant, and disable this feature after you've gotten the data
+    #: you need.
+    lti_launch_data_logging: Maybe["bool"] = Nothing
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -427,6 +431,15 @@ class AllSiteSettings(FrontendSiteSettings):
                         " check for this content id in the launch parameters."
                     ),
                 ),
+                rqa.OptionalArgument(
+                    "LTI_LAUNCH_DATA_LOGGING",
+                    rqa.SimpleValue.bool,
+                    doc=(
+                        "Enable logging of LTI launch data. NEVER ENABLE THIS"
+                        " SITE-WIDE, only for a single tenant, and disable"
+                        " this feature after you've gotten the data you need."
+                    ),
+                ),
             )
         ).use_readable_describe(True)
     )
@@ -526,6 +539,9 @@ class AllSiteSettings(FrontendSiteSettings):
         self.lti_first_launch_content_id_enabled = maybe_from_nullable(
             self.lti_first_launch_content_id_enabled
         )
+        self.lti_launch_data_logging = maybe_from_nullable(
+            self.lti_launch_data_logging
+        )
 
     def to_dict(self) -> t.Dict[str, t.Any]:
         res: t.Dict[str, t.Any] = {}
@@ -959,6 +975,10 @@ class AllSiteSettings(FrontendSiteSettings):
             res["LTI_FIRST_LAUNCH_CONTENT_ID_ENABLED"] = to_dict(
                 self.lti_first_launch_content_id_enabled.value
             )
+        if self.lti_launch_data_logging.is_just:
+            res["LTI_LAUNCH_DATA_LOGGING"] = to_dict(
+                self.lti_launch_data_logging.value
+            )
         return res
 
     @classmethod
@@ -1082,6 +1102,7 @@ class AllSiteSettings(FrontendSiteSettings):
             lti_1p3_system_role_from_context_role=parsed.LTI_1P3_SYSTEM_ROLE_FROM_CONTEXT_ROLE,
             lti_1p3_parse_most_privileged_role=parsed.LTI_1P3_PARSE_MOST_PRIVILEGED_ROLE,
             lti_first_launch_content_id_enabled=parsed.LTI_FIRST_LAUNCH_CONTENT_ID_ENABLED,
+            lti_launch_data_logging=parsed.LTI_LAUNCH_DATA_LOGGING,
         )
         res.raw_data = d
         return res

codegrade-16.1.40/codegrade/models/lti_launch_data_logging_setting.py

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

{codegrade-16.1.39 → codegrade-16.1.40}/codegrade/models/site_setting_input.py

@@ -138,6 +138,7 @@ from .lti_enabled_setting import LtiEnabledSetting
 from .lti_first_launch_content_id_enabled_setting import (
     LtiFirstLaunchContentIdEnabledSetting,
 )
+from .lti_launch_data_logging_setting import LtiLaunchDataLoggingSetting
 from .lti_lock_date_copying_enabled_setting import (
     LtiLockDateCopyingEnabledSetting,
 )
@@ -372,6 +373,7 @@ SiteSettingInput = t.Union[
     LtiFirstLaunchContentIdEnabledSetting,
     SubmissionsPageV2EnabledSetting,
     SimpleSubmissionModeEnabledSetting,
+    LtiLaunchDataLoggingSetting,
 ]
 SiteSettingInputParser = rqa.Lazy(
     lambda: make_union(
@@ -489,5 +491,6 @@ SiteSettingInputParser = rqa.Lazy(
         ParserFor.make(LtiFirstLaunchContentIdEnabledSetting),
         ParserFor.make(SubmissionsPageV2EnabledSetting),
         ParserFor.make(SimpleSubmissionModeEnabledSetting),
+        ParserFor.make(LtiLaunchDataLoggingSetting),
     ),
 )

{codegrade-16.1.39 → codegrade-16.1.40}/pyproject.toml

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

{codegrade-16.1.39 → codegrade-16.1.40}/setup.py

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