codegrade 16.1.23__tar.gz → 16.1.24__tar.gz

{codegrade-16.1.23 → codegrade-16.1.24}/PKG-INFO

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

{codegrade-16.1.23 → codegrade-16.1.24}/codegrade/_api/git_provider.py

@@ -228,3 +228,62 @@ class GitProviderService(t.Generic[_ClientT]):
                 ),
             ),
         )
+
+    def get_all_templates(
+        self: "GitProviderService[codegrade.client.AuthenticatedClient]",
+        *,
+        provider_id: "str",
+        token_id: "str",
+        after: Maybe["str"] = Nothing,
+        extra_parameters: t.Optional[
+            t.Mapping[str, t.Union[str, bool, int, float]]
+        ] = None,
+    ) -> "GitRepositoriesPage":
+        """Get all template repositories for the given git provider.
+
+        Note: We do not yet support GitLab templates.
+
+        :param provider_id: The provider from which you want to retrieve repos.
+        :param token_id: The token to use to retrieve the repos.
+        :param after: If given results after this cursor will be retrieved.
+        :param extra_parameters: The extra query parameters you might want to
+            add. By default no extra query parameters are added.
+
+        :returns: The token.
+        """
+
+        url = (
+            "/api/v1/git_providers/{providerId}/tokens/{tokenId}/templates/"
+            .format(providerId=provider_id, tokenId=token_id)
+        )
+        params: t.Dict[str, t.Any] = {
+            **(extra_parameters or {}),
+        }
+        maybe_from_nullable(t.cast(t.Any, after)).if_just(
+            lambda val: params.__setitem__("after", val)
+        )
+
+        with self.__client as client:
+            resp = client.http.get(url=url, params=params)
+        utils.log_warnings(resp)
+
+        if utils.response_code_matches(resp.status_code, 200):
+            # fmt: off
+            from ..models.git_repositories_page import GitRepositoriesPage
+
+            # fmt: on
+            return parsers.JsonResponseParser(
+                parsers.ParserFor.make(GitRepositoriesPage)
+            ).try_parse(resp)
+
+        from ..models.any_error import AnyError
+
+        raise utils.get_error(
+            resp,
+            (
+                (
+                    (400, 409, 401, 403, 404, 429, 500),
+                    utils.unpack_union(AnyError),
+                ),
+            ),
+        )

{codegrade-16.1.23 → codegrade-16.1.24}/codegrade/client.py

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

{codegrade-16.1.23 → codegrade-16.1.24}/codegrade/models/__init__.py

@@ -667,8 +667,12 @@ from .user_without_group import UserWithoutGroup
 from .weak_password_exception import WeakPasswordException
 from .weak_password_feedback import WeakPasswordFeedback
 from .webhook_base import WebhookBase
-from .webhook_disabled_configuration import WebhookDisabledConfiguration
-from .webhook_enabled_configuration import WebhookEnabledConfiguration
+from .webhook_configuration_disabled_as_json import (
+    WebhookConfigurationDisabledAsJSON,
+)
+from .webhook_configuration_enabled_as_json import (
+    WebhookConfigurationEnabledAsJSON,
+)
 from .work import Work
 from .work_origin import WorkOrigin
 from .work_rubric_item import WorkRubricItem

{codegrade-16.1.23 → codegrade-16.1.24}/codegrade/models/assignment.py

@@ -23,8 +23,12 @@ from .fixed_grade_availability import FixedGradeAvailability
 from .group_set import GroupSet
 from .submission_validator_input_data import SubmissionValidatorInputData
 from .timeframe_like import TimeframeLike
-from .webhook_disabled_configuration import WebhookDisabledConfiguration
-from .webhook_enabled_configuration import WebhookEnabledConfiguration
+from .webhook_configuration_disabled_as_json import (
+    WebhookConfigurationDisabledAsJSON,
+)
+from .webhook_configuration_enabled_as_json import (
+    WebhookConfigurationEnabledAsJSON,
+)
 
 
 @dataclass
@@ -91,7 +95,7 @@ class Assignment(TimeframeLike):
     #: `webhook_configuration`\` instead.
     webhook_upload_enabled: "bool"
     #: Settings for the git connection to this assignment.
-    webhook_configuration: "t.Union[WebhookEnabledConfiguration, WebhookDisabledConfiguration]"
+    webhook_configuration: "t.Union[WebhookConfigurationEnabledAsJSON, WebhookConfigurationDisabledAsJSON]"
     #: Can you use the editor for this assignment.
     editor_upload_enabled: "bool"
     #: The maximum amount of submission a student may create, inclusive. The
@@ -302,8 +306,12 @@ class Assignment(TimeframeLike):
                 rqa.RequiredArgument(
                     "webhook_configuration",
                     parsers.make_union(
-                        parsers.ParserFor.make(WebhookEnabledConfiguration),
-                        parsers.ParserFor.make(WebhookDisabledConfiguration),
+                        parsers.ParserFor.make(
+                            WebhookConfigurationEnabledAsJSON
+                        ),
+                        parsers.ParserFor.make(
+                            WebhookConfigurationDisabledAsJSON
+                        ),
                     ),
                     doc="Settings for the git connection to this assignment.",
                 ),

{codegrade-16.1.23 → codegrade-16.1.24}/codegrade/models/git_repository_like.py

@@ -21,6 +21,10 @@ class GitRepositoryLike:
     name: "str"
     #: The URL of the repository.
     url: "str"
+    #: Whether the repository is a template.
+    is_template: "bool"
+    #: Whether the repository is private.
+    is_private: "bool"
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -41,6 +45,16 @@ class GitRepositoryLike:
                 rqa.SimpleValue.str,
                 doc="The URL of the repository.",
             ),
+            rqa.RequiredArgument(
+                "is_template",
+                rqa.SimpleValue.bool,
+                doc="Whether the repository is a template.",
+            ),
+            rqa.RequiredArgument(
+                "is_private",
+                rqa.SimpleValue.bool,
+                doc="Whether the repository is private.",
+            ),
         ).use_readable_describe(True)
     )
 
@@ -49,6 +63,8 @@ class GitRepositoryLike:
             "id": to_dict(self.id),
             "name": to_dict(self.name),
             "url": to_dict(self.url),
+            "is_template": to_dict(self.is_template),
+            "is_private": to_dict(self.is_private),
         }
         return res
 
@@ -62,6 +78,8 @@ class GitRepositoryLike:
             id=parsed.id,
             name=parsed.name,
             url=parsed.url,
+            is_template=parsed.is_template,
+            is_private=parsed.is_private,
         )
         res.raw_data = d
         return res

{codegrade-16.1.23 → codegrade-16.1.24}/codegrade/models/json_patch_submit_types_assignment.py

@@ -12,8 +12,12 @@ from cg_maybe.utils import maybe_from_nullable
 
 from .. import parsers
 from ..utils import to_dict
-from .webhook_disabled_configuration import WebhookDisabledConfiguration
-from .webhook_enabled_configuration import WebhookEnabledConfiguration
+from .webhook_configuration_disabled_as_json import (
+    WebhookConfigurationDisabledAsJSON,
+)
+from .webhook_configuration_enabled_as_json import (
+    WebhookConfigurationEnabledAsJSON,
+)
 
 
 @dataclass
@@ -26,7 +30,8 @@ class JsonPatchSubmitTypesAssignment:
     webhook_upload_enabled: Maybe["bool"] = Nothing
     #: The configuration for the Webhook upload for this assignment
     webhook_configuration: Maybe[
-        "t.Union[WebhookEnabledConfiguration, WebhookDisabledConfiguration]"
+        "t.Union[WebhookConfigurationEnabledAsJSON,"
+        " WebhookConfigurationDisabledAsJSON]"
     ] = Nothing
     #: Should students be allowed to make submissions using the editor
     editor_upload_enabled: Maybe["bool"] = Nothing
@@ -54,8 +59,8 @@ class JsonPatchSubmitTypesAssignment:
             rqa.OptionalArgument(
                 "webhook_configuration",
                 parsers.make_union(
-                    parsers.ParserFor.make(WebhookEnabledConfiguration),
-                    parsers.ParserFor.make(WebhookDisabledConfiguration),
+                    parsers.ParserFor.make(WebhookConfigurationEnabledAsJSON),
+                    parsers.ParserFor.make(WebhookConfigurationDisabledAsJSON),
                 ),
                 doc=(
                     "The configuration for the Webhook upload for this"

codegrade-16.1.23/codegrade/models/webhook_disabled_configuration.py → codegrade-16.1.24/codegrade/models/webhook_configuration_disabled_as_json.py

@@ -1,4 +1,4 @@
-"""The module that defines the ``WebhookDisabledConfiguration`` model.
+"""The module that defines the ``WebhookConfigurationDisabledAsJSON`` model.
 
 SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
 """
@@ -12,7 +12,7 @@ from ..utils import to_dict
 
 
 @dataclass
-class WebhookDisabledConfiguration:
+class WebhookConfigurationDisabledAsJSON:
     """Webhook upload type is disabled."""
 
     #: The tag for this data.
@@ -38,8 +38,9 @@ class WebhookDisabledConfiguration:
 
     @classmethod
     def from_dict(
-        cls: t.Type["WebhookDisabledConfiguration"], d: t.Dict[str, t.Any]
-    ) -> "WebhookDisabledConfiguration":
+        cls: t.Type["WebhookConfigurationDisabledAsJSON"],
+        d: t.Dict[str, t.Any],
+    ) -> "WebhookConfigurationDisabledAsJSON":
         parsed = cls.data_parser.try_parse(d)
 
         res = cls(

codegrade-16.1.23/codegrade/models/webhook_enabled_configuration.py → codegrade-16.1.24/codegrade/models/webhook_configuration_enabled_as_json.py

@@ -1,4 +1,4 @@
-"""The module that defines the ``WebhookEnabledConfiguration`` model.
+"""The module that defines the ``WebhookConfigurationEnabledAsJSON`` model.
 
 SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
 """
@@ -12,7 +12,7 @@ from ..utils import to_dict
 
 
 @dataclass
-class WebhookEnabledConfiguration:
+class WebhookConfigurationEnabledAsJSON:
     """Webhook upload type is enabled."""
 
     #: The tag for this data.
@@ -20,6 +20,9 @@ class WebhookEnabledConfiguration:
     #: A url for a repository that determine the template for student
     #: submissions.
     template_url: "t.Optional[str]"
+    #: The token to use for the template connection. It is present only for
+    #: private template repository.
+    template_token_id: "t.Optional[str]"
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -38,6 +41,14 @@ class WebhookEnabledConfiguration:
                     " student submissions."
                 ),
             ),
+            rqa.RequiredArgument(
+                "template_token_id",
+                rqa.Nullable(rqa.SimpleValue.str),
+                doc=(
+                    "The token to use for the template connection. It is"
+                    " present only for private template repository."
+                ),
+            ),
         ).use_readable_describe(True)
     )
 
@@ -45,18 +56,20 @@ class WebhookEnabledConfiguration:
         res: t.Dict[str, t.Any] = {
             "tag": to_dict(self.tag),
             "template_url": to_dict(self.template_url),
+            "template_token_id": to_dict(self.template_token_id),
         }
         return res
 
     @classmethod
     def from_dict(
-        cls: t.Type["WebhookEnabledConfiguration"], d: t.Dict[str, t.Any]
-    ) -> "WebhookEnabledConfiguration":
+        cls: t.Type["WebhookConfigurationEnabledAsJSON"], d: t.Dict[str, t.Any]
+    ) -> "WebhookConfigurationEnabledAsJSON":
         parsed = cls.data_parser.try_parse(d)
 
         res = cls(
             tag=parsed.tag,
             template_url=parsed.template_url,
+            template_token_id=parsed.template_token_id,
         )
         res.raw_data = d
         return res

{codegrade-16.1.23 → codegrade-16.1.24}/pyproject.toml

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

{codegrade-16.1.23 → codegrade-16.1.24}/setup.py

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