codegrade 16.1.60__tar.gz → 16.1.61__tar.gz

{codegrade-16.1.60 → codegrade-16.1.61}/PKG-INFO

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

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/_api/task_result.py

@@ -191,7 +191,7 @@ class TaskResultService(t.Generic[_ClientT]):
     ) -> "None":
         """Revoke a task result.
 
-        The revoked task must be in the \"not\_started\" state.
+        The revoked task must be in the \"not_started\" state.
 
         :param task_result_id: The task result to revoke.
         :param extra_parameters: The extra query parameters you might want to

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/_api/user.py

@@ -199,7 +199,7 @@ class UserService(t.Generic[_ClientT]):
     ) -> "t.Union[ExtendedUser, User, t.Mapping[str, str]]":
         """Get the info of the currently logged in user.
 
-        :param type: If this is `roles` a mapping between course\_id and role
+        :param type: If this is `roles` a mapping between course_id and role
             name will be returned, if this is `extended` an `ExtendedUser`
             instead of a `User` will be returned.
         :param extended: If `true` this has the same effect as setting `type`

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/client.py

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

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/models/all_site_settings.py

@@ -57,7 +57,7 @@ class AllSiteSettings(FrontendSiteSettings):
     new_auto_test_max_output_files_size: Maybe["int"] = Nothing
     #: The IDs of the available base images for AutoTest 2.0.
     new_auto_test_allowed_initial_build_ids: Maybe["t.Sequence[str]"] = Nothing
-    #: Unused, use NEW\_AUTO\_TEST\_CURRENT\_INITIAL\_BUILD\_IDS.
+    #: Unused, use `NEW_AUTO_TEST_CURRENT_INITIAL_BUILD_IDS`.
     new_auto_test_initial_build_id: Maybe["str"] = Nothing
     #: The minimum strength passwords by users should have. The higher this
     #: value the stronger the password should be. When increasing the strength
@@ -78,7 +78,7 @@ class AllSiteSettings(FrontendSiteSettings):
     #: this size might cause a hosting costs to increase.
     max_normal_upload_size: Maybe["int"] = Nothing
     #: The maximum total size of files part of an editor submission in
-    #: dynamodb. This is not the same as MAX\_NORMAL\_UPLOAD\_SIZE. Increasing
+    #: dynamodb. This is not the same as `MAX_NORMAL_UPLOAD_SIZE`. Increasing
     #: this size might cause a hosting costs to increase.
     max_dynamo_submission_size: Maybe["int"] = Nothing
     #: The maximum size of a single file uploaded by normal users. This limit
@@ -86,14 +86,14 @@ class AllSiteSettings(FrontendSiteSettings):
     #: which can't really be downloaded/shown anyway.
     max_file_size: Maybe["int"] = Nothing
     #: The maximum size of a single file's updates in dynamodb. This is not the
-    #: same as MAX\_FILE\_SIZE. This limit is to avoid having huge files stored
+    #: same as `MAX_FILE_SIZE`. This limit is to avoid having huge files stored
     #: in dynamodb, as storage is expensive.
     max_dynamo_file_size: Maybe["int"] = Nothing
     #: The maximum size of a single update (CRDT) to a file in dynamodb. This
-    #: is not the same as MAX\_DYNAMO\_FILE\_SIZE, as it refers to a single
-    #: edit operation. This limit is to avoid having huge items stored in
-    #: dynamodb, as storage is expensive. If the CRDT exceeds the given size,
-    #: it will be uploaded to a S3 object.
+    #: is not the same as `MAX_DYNAMO_FILE_SIZE`, as it refers to a single edit
+    #: operation. This limit is to avoid having huge items stored in dynamodb,
+    #: as storage is expensive. If the CRDT exceeds the given size, it will be
+    #: uploaded to a S3 object.
     max_document_update_size: Maybe["int"] = Nothing
     #: The time a login session is valid. After this amount of time a user will
     #: always need to re-authenticate.
@@ -112,8 +112,8 @@ class AllSiteSettings(FrontendSiteSettings):
     #: Wether to allow LTI to unset the deadline and lockdate of an assignment.
     lti_unset_deadline_lock_date_enabled: Maybe["bool"] = Nothing
     #: Also look at context roles when determining the system role for a new
-    #: user in LMSes that have an extra\_roles\_mapping defined in their
-    #: lms\_capabilities.
+    #: user in LMSes that have an `extra_roles_mapping` defined in their
+    #: `lms_capabilities`.
     lti_1p3_system_role_from_context_role: Maybe["bool"] = Nothing
     #: Prefer the most privileged role in the LTI 1.3 roles claim sent by the
     #: LMS, instead of the first role that matches any of our definitions.
@@ -277,7 +277,7 @@ class AllSiteSettings(FrontendSiteSettings):
                     rqa.SimpleValue.str,
                     doc=(
                         "Unused, use"
-                        " NEW\\_AUTO\\_TEST\\_CURRENT\\_INITIAL\\_BUILD\\_IDS."
+                        " `NEW_AUTO_TEST_CURRENT_INITIAL_BUILD_IDS`."
                     ),
                 ),
                 rqa.OptionalArgument(
@@ -334,8 +334,8 @@ class AllSiteSettings(FrontendSiteSettings):
                     doc=(
                         "The maximum total size of files part of an editor"
                         " submission in dynamodb. This is not the same as"
-                        " MAX\\_NORMAL\\_UPLOAD\\_SIZE. Increasing this size"
-                        " might cause a hosting costs to increase."
+                        " `MAX_NORMAL_UPLOAD_SIZE`. Increasing this size might"
+                        " cause a hosting costs to increase."
                     ),
                 ),
                 rqa.OptionalArgument(
@@ -353,7 +353,7 @@ class AllSiteSettings(FrontendSiteSettings):
                     rqa.SimpleValue.int,
                     doc=(
                         "The maximum size of a single file's updates in"
-                        " dynamodb. This is not the same as MAX\\_FILE\\_SIZE."
+                        " dynamodb. This is not the same as `MAX_FILE_SIZE`."
                         " This limit is to avoid having huge files stored in"
                         " dynamodb, as storage is expensive."
                     ),
@@ -364,7 +364,7 @@ class AllSiteSettings(FrontendSiteSettings):
                     doc=(
                         "The maximum size of a single update (CRDT) to a file"
                         " in dynamodb. This is not the same as"
-                        " MAX\\_DYNAMO\\_FILE\\_SIZE, as it refers to a single"
+                        " `MAX_DYNAMO_FILE_SIZE`, as it refers to a single"
                         " edit operation. This limit is to avoid having huge"
                         " items stored in dynamodb, as storage is expensive."
                         " If the CRDT exceeds the given size, it will be"
@@ -425,8 +425,8 @@ class AllSiteSettings(FrontendSiteSettings):
                     doc=(
                         "Also look at context roles when determining the"
                         " system role for a new user in LMSes that have an"
-                        " extra\\_roles\\_mapping defined in their"
-                        " lms\\_capabilities."
+                        " `extra_roles_mapping` defined in their"
+                        " `lms_capabilities`."
                     ),
                 ),
                 rqa.OptionalArgument(

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/models/assignment.py

@@ -41,8 +41,8 @@ class Assignment(TimeframeLike):
 
     #: The id of the assignment.
     id: "int"
-    #: Current state of the assignment. Deprecated: use availability and
-    #: grade\_availability fields, it will be removed in Q3 2023.
+    #: Current state of the assignment. Deprecated: use `availability` and
+    #: `grade_availability` fields, it will be removed in Q3 2023.
     state: "t.Literal['done', 'grading', 'hidden', 'submitting']"
     #: Description of the assignment. Deprecated, use available routes to
     #: upload and retrieve a description file instead. It will be removed in Q3
@@ -65,8 +65,8 @@ class Assignment(TimeframeLike):
     #: The time the assignment will become available (i.e. the state will
     #: switch from 'hidden' to 'open'). If the state is not 'hidden' this value
     #: has no meaning. If this value is not `None` you cannot change to state
-    #: to 'hidden' or 'open'. Deprecated: use availability and
-    #: grade\_availability fields, it will be removed in Q3 2023.
+    #: to 'hidden' or 'open'. Deprecated: use `availability` and
+    #: `grade_availability` fields, it will be removed in Q3 2023.
     available_at: "t.Optional[datetime.datetime]"
     #: Should we send login links to all users before the `available_at` time.
     send_login_links: "bool"
@@ -79,8 +79,8 @@ class Assignment(TimeframeLike):
     #: and regarded as a 10.
     max_grade: "float"
     #: Settings that influence how the grade for a submission can be
-    #: determined. TODO: Should we also move max\_grade and/or
-    #: fixed\_max\_rubric\_points to the grading object?
+    #: determined. TODO: Should we also move `max_grade` and/or
+    #: `fixed_max_rubric_points` to the grading object?
     grading: "t.Union[AssignmentPointsGradingSettings, AssignmentPercentageGradingSettings]"
     #: The group set of this assignment. This is `None` if this assignment is
     #: not a group assignment.
@@ -160,7 +160,7 @@ class Assignment(TimeframeLike):
                     rqa.StringEnum("done", "grading", "hidden", "submitting"),
                     doc=(
                         "Current state of the assignment. Deprecated: use"
-                        " availability and grade\\_availability fields, it"
+                        " `availability` and `grade_availability` fields, it"
                         " will be removed in Q3 2023."
                     ),
                 ),
@@ -225,7 +225,7 @@ class Assignment(TimeframeLike):
                         " the state is not 'hidden' this value has no meaning."
                         " If this value is not `None` you cannot change to"
                         " state to 'hidden' or 'open'. Deprecated: use"
-                        " availability and grade\\_availability fields, it"
+                        " `availability` and `grade_availability` fields, it"
                         " will be removed in Q3 2023."
                     ),
                 ),
@@ -270,8 +270,8 @@ class Assignment(TimeframeLike):
                     doc=(
                         "Settings that influence how the grade for a"
                         " submission can be determined. TODO: Should we also"
-                        " move max\\_grade and/or"
-                        " fixed\\_max\\_rubric\\_points to the grading object?"
+                        " move `max_grade` and/or `fixed_max_rubric_points` to"
+                        " the grading object?"
                     ),
                 ),
                 rqa.RequiredArgument(

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/models/frontend_site_settings.py

@@ -40,9 +40,9 @@ class FrontendSiteSettings:
     #: The IDs of the currently recent base images for AutoTest 2.0. These are
     #: the images that we want users to use for new AutoTest 2.0
     #: configurations. Make sure that if you add something to this list it is
-    #: also added to NEW\_AUTO\_TEST\_ALLOWED\_INITIAL\_BUILD\_IDS, as
-    #: otherwise the user is not allowed to use the image. The last item in
-    #: this list will be the default image id.
+    #: also added to `NEW_AUTO_TEST_ALLOWED_INITIAL_BUILD_IDS`, as otherwise
+    #: the user is not allowed to use the image. The last item in this list
+    #: will be the default image id.
     new_auto_test_current_initial_build_ids: Maybe["t.Sequence[str]"] = Nothing
     #: The maximum time a command may run in the build part of AutoTest 2.0.
     new_auto_test_build_max_command_time: Maybe["datetime.timedelta"] = Nothing
@@ -113,7 +113,7 @@ class FrontendSiteSettings:
     #: Should rubrics be submitted incrementally, so if a user selects a item
     #: should this be automatically be submitted to the server, or should it
     #: only be possible to submit a complete rubric at once. This feature is
-    #: useless if rubrics is not set to true.
+    #: useless if `rubrics` is not set to `true`.
     incremental_rubric_submission_enabled: Maybe["bool"] = Nothing
     #: Should it be possible to register on the website. This makes it possible
     #: for any body to register an account on the website.
@@ -162,7 +162,7 @@ class FrontendSiteSettings:
     #: The interval at which we request the server time in case it is out of
     #: sync with the local time.
     server_time_sync_interval: Maybe["datetime.timedelta"] = Nothing
-    #: Whether the is\_admin global permission should be enabled. Users with a
+    #: Whether the `is_admin` global permission should be enabled. Users with a
     #: global role with this permission automatically get all permissions,
     #: everywhere. Users with a tenant role with this permission automatically
     #: get all permissions within their tenant.
@@ -179,7 +179,7 @@ class FrontendSiteSettings:
     #: Should the lock date be copied from the LMS through LTI, or should we
     #: allow the user to set it in CodeGrade.
     lti_lock_date_copying_enabled: Maybe["bool"] = Nothing
-    #: Whether the Max Points field within the assignment general settings is
+    #: Whether the "Max Points" field within the assignment general settings is
     #: enabled. If disabled, teachers will not be able to award extra points
     #: for assignments.
     assignment_max_points_enabled: Maybe["bool"] = Nothing
@@ -373,9 +373,9 @@ class FrontendSiteSettings:
                     " 2.0. These are the images that we want users to use for"
                     " new AutoTest 2.0 configurations. Make sure that if you"
                     " add something to this list it is also added to"
-                    " NEW\\_AUTO\\_TEST\\_ALLOWED\\_INITIAL\\_BUILD\\_IDS, as"
-                    " otherwise the user is not allowed to use the image. The"
-                    " last item in this list will be the default image id."
+                    " `NEW_AUTO_TEST_ALLOWED_INITIAL_BUILD_IDS`, as otherwise"
+                    " the user is not allowed to use the image. The last item"
+                    " in this list will be the default image id."
                 ),
             ),
             rqa.OptionalArgument(
@@ -560,7 +560,7 @@ class FrontendSiteSettings:
                     " selects a item should this be automatically be submitted"
                     " to the server, or should it only be possible to submit a"
                     " complete rubric at once. This feature is useless if"
-                    " rubrics is not set to true."
+                    " `rubrics` is not set to `true`."
                 ),
             ),
             rqa.OptionalArgument(
@@ -687,7 +687,7 @@ class FrontendSiteSettings:
                 "IS_ADMIN_PERMISSION_ENABLED",
                 rqa.SimpleValue.bool,
                 doc=(
-                    "Whether the is\\_admin global permission should be"
+                    "Whether the `is_admin` global permission should be"
                     " enabled. Users with a global role with this permission"
                     " automatically get all permissions, everywhere. Users"
                     " with a tenant role with this permission automatically"
@@ -732,7 +732,7 @@ class FrontendSiteSettings:
                 "ASSIGNMENT_MAX_POINTS_ENABLED",
                 rqa.SimpleValue.bool,
                 doc=(
-                    "Whether the Max Points field within the assignment"
+                    'Whether the "Max Points" field within the assignment'
                     " general settings is enabled. If disabled, teachers will"
                     " not be able to award extra points for assignments."
                 ),

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/models/patch_assignment_data.py

@@ -32,8 +32,8 @@ from .timed_availability import TimedAvailability
 class PatchAssignmentData:
     """Input data required for the `Assignment::Patch` operation."""
 
-    #: The new state of the assignment. Deprecated, use the "availability" and
-    #: "grade\_availability" options, will be removed in Q3 2023.
+    #: The new state of the assignment. Deprecated, use the `availability` and
+    #: `grade_availability` options, will be removed in Q3 2023.
     state: Maybe["AssignmentStateEnum"] = Nothing
     #: The new name of the assignment
     name: Maybe["str"] = Nothing
@@ -112,8 +112,8 @@ class PatchAssignmentData:
                 rqa.EnumValue(AssignmentStateEnum),
                 doc=(
                     "The new state of the assignment. Deprecated, use the"
-                    ' "availability" and "grade\\_availability" options, will'
-                    " be removed in Q3 2023."
+                    " `availability` and `grade_availability` options, will be"
+                    " removed in Q3 2023."
                 ),
             ),
             rqa.OptionalArgument(

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/models/saml2_provider_json.py

@@ -15,7 +15,7 @@ from .saml_ui_info import SamlUiInfo
 
 @dataclass
 class Saml2ProviderJSON:
-    """The serialization of a <span data-role="class">Saml2Provider</span>."""
+    """The serialization of a `Saml2Provider`."""
 
     #: The `id` of the provider.
     id: "str"

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/models/submission_validator_input_data.py

@@ -20,7 +20,7 @@ class SubmissionValidatorInputData:
 
     #: The default policy of this validator.
     policy: "t.Literal['allow_all_files', 'deny_all_files']"
-    #: The rules in this validator. If the policy is "deny\_all\_files" this
+    #: The rules in this validator. If the policy is "deny_all_files" this
     #: should not be empty.
     rules: "t.Sequence[FileRuleInputData]"
     #: The options for this validator.
@@ -40,7 +40,7 @@ class SubmissionValidatorInputData:
                 rqa.List(parsers.ParserFor.make(FileRuleInputData)),
                 doc=(
                     "The rules in this validator. If the policy is"
-                    ' "deny\\_all\\_files" this should not be empty.'
+                    ' "deny_all_files" this should not be empty.'
                 ),
             ),
             rqa.RequiredArgument(

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/models/update_suite_auto_test_base_data.py

@@ -20,7 +20,7 @@ from .run_program_input_as_json import RunProgramInputAsJSON
 
 @dataclass
 class UpdateSuiteAutoTestBaseData:
-    """The required data for the AutoTest::UpdateSuite operation."""
+    """The required data for the `AutoTest::UpdateSuite` operation."""
 
     #: The steps that should be in this suite. They will be run as the order
     #: they are provided in.

{codegrade-16.1.60 → codegrade-16.1.61}/codegrade/models/update_suite_auto_test_data.py

@@ -17,7 +17,9 @@ from .update_suite_auto_test_base_data import UpdateSuiteAutoTestBaseData
 
 @dataclass
 class UpdateSuiteAutoTestData(UpdateSuiteAutoTestBaseData):
-    """The required and optional data for the AutoTest::UpdateSuite operation."""
+    """The required and optional data for the `AutoTest::UpdateSuite`
+    operation.
+    """
 
     #: The id of the suite you want to edit. If not provided we will create a
     #: new suite.

{codegrade-16.1.60 → codegrade-16.1.61}/pyproject.toml

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

{codegrade-16.1.60 → codegrade-16.1.61}/setup.py

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