Merge branch 'ucfopen:develop' into issue/440-allow-sis-ids

Author: ndegroot

.github/CONTRIBUTING.md

@@ -7,26 +7,26 @@ Below you'll find guidelines for contributing that will keep our codebase clean
 ## Table of Contents
 
 * [Contributing to CanvasAPI](#contributing-to-canvasapi)
-    * [Table of Contents](#table-of-contents)
-    * [How can I contribute?](#how-can-i-contribute)
-        * [Bug reports](#bug-reports)
-        * [Resolving issues](#resolving-issues)
-        * [Making your first contribution](#making-your-first-contribution)
-            * [Setting up the environment](#setting-up-the-environment)
-            * [Writing tests](#writing-tests)
-                * [API coverage tests](#api-coverage-tests)
-                * [Engine tests](#engine-tests)
-            * [Running tests / coverage reports](#running-tests--coverage-reports)
-            * [Making a pull request](#making-a-pull-request)
-    * [Code style guidelines](#code-style-guidelines)
-        * [Running code style checks](#running-code-style-checks)
-        * [Foolish consistency](#foolish-consistency)
-        * [Method docstrings](#method-docstrings)
-            * [Descriptions](#descriptions)
-            * [Links to related API endpoints](#links-to-related-api-endpoints)
-            * [Parameters](#parameters)
-            * [Returns](#returns)
-            * [Docstring Examples](#docstring-examples)
+  * [Table of Contents](#table-of-contents)
+  * [How can I contribute?](#how-can-i-contribute)
+    * [Bug reports](#bug-reports)
+    * [Resolving issues](#resolving-issues)
+    * [Making your first contribution](#making-your-first-contribution)
+      * [Setting up the environment](#setting-up-the-environment)
+      * [Writing tests](#writing-tests)
+        * [API coverage tests](#api-coverage-tests)
+        * [Engine tests](#engine-tests)
+      * [Running tests / coverage reports](#running-tests--coverage-reports)
+      * [Making a pull request](#making-a-pull-request)
+  * [Code style guidelines](#code-style-guidelines)
+    * [Running code style checks](#running-code-style-checks)
+    * [Foolish consistency](#foolish-consistency)
+    * [Method docstrings](#method-docstrings)
+      * [Descriptions](#descriptions)
+      * [Links to related API endpoints](#links-to-related-api-endpoints)
+      * [Parameters](#parameters)
+      * [Returns](#returns)
+      * [Docstring Examples](#docstring-examples)
 
 ## How can I contribute?
 

.github/workflows/run-tests.yml

@@ -11,12 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

AUTHORS.md

@@ -17,6 +17,7 @@
 - Adrian Goetz [@a-goetz](https://github.com/a-goetz)
 - Aileen Pongnon [@aileenpongnon](https://github.com/aileenpongnon)
 - Alyssa Davis [@allygator](https://github.com/allygator)
+- Alex Gabriel Nunez-Carrasquillo [@alportoricensis](https://github.com/alportoricensis)
 - [@amorqiu](https://github.com/amorqiu)
 - Andrew Gardener [@andrew-gardener](https://github.com/andrew-gardener)
 - Anthony Rodriguez [@AnthonyRodriguez726](https://github.com/AnthonyRodriguez726)
@@ -42,6 +43,7 @@
 - Deundre Williams [@deundrewilliams](https://github.com/deundrewilliams)
 - Devin Singh [@devints47](https://github.com/devints47)
 - Dmitry Savransky [@dsavransky](https://github.com/dsavransky)
+- Elias [@HandcartCactus](https://github.com/HandcartCactus)
 - Elise Heron [@thedarkestknight](https://github.com/thedarkestknight)
 - Elli Howard [@qwertynerd97](https://github.com/qwertynerd97)
 - Erik Tews [@eriktews](https://github.com/eriktews)
@@ -53,6 +55,7 @@
 - Ian Altgilbers [@altgilbers](https://github.com/altgilbers)
 - Ian Turgeon [@iturgeon](https://github.com/iturgeon)
 - [@jackrsteiner](https://github.com/jackrsteiner)
+- Jasmine Hou [@jsmnhou](https://github.com/jsmnhou)
 - John Raible [@rebelaide](https://github.com/rebelaide)
 - Joon Ro [@joonro](https://github.com/joonro)
 - Jonah Majumder [@jonahmajumder](https://github.com/jonahmajumder)

CHANGELOG.md

@@ -2,9 +2,23 @@
 
 ## [Unreleased]
 
+### New Endpoint Coverage
+
+- LTI Resource Links (Thanks, [@jsmnhou](https://github.com/jsmnhou))
+- Smart Search API [BETA] (Thanks, [@alportoricensis](https://github.com/alportoricensis))
+- New Quizzes Accommodations
+
+### General
+
+- Added support for Python 3.12 and 3.13
+- Dropped support for Python 3.7 and 3.8
+
 ### Backstage
 
 - Updated deploy Action to use more modern processes.
+- Updated `PaginatedList` to be type-aware, showing which class is included in the response. (Thanks [@HandcartCactus](https://github.com/HandcartCactus))
+- Updated Sphinx
+- Reworked how `Requester` handles JSON-only POST requests (currently, only New Quizzes Accommodations and GraphQL)
 
 ## [3.3.0] - 2023-08-27
 

canvasapi/canvas.py

@@ -1276,11 +1276,13 @@ def graphql(self, query, variables=None, **kwargs):
             "POST",
             "graphql",
             headers={"Content-Type": "application/json"},
-            _kwargs=combine_kwargs(**kwargs)
-            + [("query", query), ("variables", variables)],
+            _kwargs=combine_kwargs(**kwargs),
             # Needs to call special endpoint without api/v1
             _url="graphql",
-            json=True,
+            json={
+                "query": query,
+                "variables": variables if variables else {},
+            },
         )
 
         return response.json()

canvasapi/course.py

@@ -23,14 +23,16 @@
 from canvasapi.grading_period import GradingPeriod
 from canvasapi.grading_standard import GradingStandard
 from canvasapi.license import License
+from canvasapi.lti_resource_link import LTIResourceLink
 from canvasapi.module import Module
-from canvasapi.new_quiz import NewQuiz
+from canvasapi.new_quiz import AccommodationResponse, NewQuiz
 from canvasapi.outcome_import import OutcomeImport
 from canvasapi.page import Page
 from canvasapi.paginated_list import PaginatedList
 from canvasapi.progress import Progress
 from canvasapi.quiz import QuizExtension
 from canvasapi.rubric import Rubric, RubricAssociation
+from canvasapi.searchresult import SearchResult
 from canvasapi.submission import GroupedSubmission, Submission
 from canvasapi.tab import Tab
 from canvasapi.todo import Todo
@@ -439,6 +441,39 @@ def create_late_policy(self, **kwargs):
 
         return LatePolicy(self._requester, late_policy_json["late_policy"])
 
+    def create_lti_resource_link(self, url, title=None, custom=None, **kwargs):
+        """
+        Create a new LTI resource link.
+
+        :calls: `POST /api/v1/courses/:course_id/lti_resource_links \
+        <https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.create>`_
+
+        :param url: The launch URL for the resource link.
+        :type url: `str`
+        :param title: The title of the resource link.
+        :type title: `str`, optional
+        :param custom: Custom parameters to send to the tool.
+        :type custom: `dict`, optional
+
+        :rtype: :class:`canvasapi.lti_resource_link.LTIResourceLink`
+        """
+
+        if not url:
+            raise RequiredFieldMissing("url is required as a str.")
+
+        kwargs["url"] = url
+        if title:
+            kwargs["title"] = title
+        if custom:
+            kwargs["custom"] = custom
+
+        response = self._requester.request(
+            "POST",
+            f"courses/{self.id}/lti_resource_links",
+            _kwargs=combine_kwargs(**kwargs),
+        )
+        return LTIResourceLink(self._requester, response.json())
+
     def create_module(self, module, **kwargs):
         """
         Create a new module.
@@ -1646,6 +1681,49 @@ def get_licenses(self, **kwargs):
             _kwargs=combine_kwargs(**kwargs),
         )
 
+    def get_lti_resource_link(self, lti_resource_link, **kwargs):
+        """
+        Return details about the specified resource link.
+
+        :calls: `GET /api/v1/courses/:course_id/lti_resource_links/:id \
+        <https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.show>`_
+
+        :param lti_resource_link: The object or ID of the LTI resource link.
+        :type lti_resource_link: :class:`canvasapi.lti_resource_link.LTIResourceLink` or int
+
+        :rtype: :class:`canvasapi.lti_resource_link.LTIResourceLink`
+        """
+
+        lti_resource_link_id = obj_or_id(
+            lti_resource_link, "lti_resource_link", (LTIResourceLink,)
+        )
+
+        response = self._requester.request(
+            "GET",
+            f"courses/{self.id}/lti_resource_links/{lti_resource_link_id}",
+            _kwargs=combine_kwargs(**kwargs),
+        )
+        return LTIResourceLink(self._requester, response.json())
+
+    def get_lti_resource_links(self, **kwargs):
+        """
+        Returns all LTI resource links for this course as a PaginatedList.
+
+        :calls: `GET /api/v1/courses/:course_id/lti_resource_links \
+        <https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.index>`_
+
+        :rtype: :class:`canvasapi.paginated_list.PaginatedList` of
+            :class:`canvasapi.lti_resource_link.LTIResourceLink`
+        """
+
+        return PaginatedList(
+            LTIResourceLink,
+            self._requester,
+            "GET",
+            f"courses/{self.id}/lti_resource_links",
+            kwargs=combine_kwargs(**kwargs),
+        )
+
     def get_migration_systems(self, **kwargs):
         """
         Return a list of migration systems.
@@ -1769,7 +1847,7 @@ def get_new_quiz(self, assignment, **kwargs):
 
     def get_new_quizzes(self, **kwargs):
         """
-        Get a list of new quizzes.
+        Get a list of new quizzes in this course.
 
         :calls: `GET /api/quiz/v1/courses/:course_id/quizzes \
         <https://canvas.instructure.com/doc/api/new_quizzes.html#method.new_quizzes/quizzes_api.index>`_
@@ -1784,6 +1862,7 @@ def get_new_quizzes(self, **kwargs):
             self._requester,
             "GET",
             endpoint,
+            {"course_id": self.id},
             _url_override="new_quizzes",
             _kwargs=combine_kwargs(**kwargs),
         )
@@ -2577,6 +2656,33 @@ def resolve_path(self, full_path=None, **kwargs):
                 _kwargs=combine_kwargs(**kwargs),
             )
 
+    def set_new_quizzes_accommodations(self, accommodations, **kwargs):
+        """
+        Apply accommodations to New Quizzes at the **course level** for
+        students enrolled in this course.
+
+        :calls: `POST /api/quiz/v1/courses/:course_id/accommodations \
+        <https://developerdocs.instructure.com/services/canvas/resources/new_quizzes_accommodations#method.new_quizzes-accommodation_api.course_level_accommodations>`_
+
+        :param accommodations: A list of dictionaries containing accommodation details
+            for each user. Each dictionary must contain `user_id` and can optionally include
+            `extra_time`, `apply_to_in_progress_quiz_sessions`, and/or `reduce_choices_enabled`.
+        :type accommodations: list of dict
+
+        :returns: AccommodationResponse object containing the status of the accommodation request.
+        :rtype: :class:`canvasapi.new_quiz.AccommodationResponse`
+        """
+        endpoint = "courses/{}/accommodations".format(self.id)
+
+        response = self._requester.request(
+            "POST",
+            endpoint,
+            _url="new_quizzes",
+            _kwargs=combine_kwargs(**kwargs),
+            json=accommodations,
+        )
+        return AccommodationResponse(self._requester, response.json())
+
     def set_quiz_extensions(self, quiz_extensions, **kwargs):
         """
         Set extensions for student all quiz submissions in a course.
@@ -2668,6 +2774,32 @@ def show_front_page(self, **kwargs):
 
         return Page(self._requester, page_json)
 
+    def smartsearch(self, q, **kwargs):
+        """
+        AI-powered course content search.
+
+        :calls: `GET /api/v1/courses/:course_id/smartsearch \
+        <https://canvas.instructure.com/doc/api/smart_search.html#method.smart_search.search>`_
+
+        :param q: The search query string.
+        :type q: str
+        :param kwargs: Optional query parameters (e.g., filter, per_page).
+        :type kwargs: dict
+        :rtype: :class:`canvasapi.paginated_list.PaginatedList` of
+            :class:`canvasapi.searchresult.SearchResult`
+        """
+        kwargs["q"] = q
+
+        return PaginatedList(
+            SearchResult,
+            self._requester,
+            "GET",
+            f"courses/{self.id}/smartsearch",
+            {"course_id": self.id},
+            _root="results",
+            _kwargs=combine_kwargs(**kwargs),
+        )
+
     def submissions_bulk_update(self, **kwargs):
         """
         Update the grading and comments on multiple student's assignment

canvasapi/lti_resource_link.py

@@ -0,0 +1,6 @@
+from canvasapi.canvas_object import CanvasObject
+
+
+class LTIResourceLink(CanvasObject):
+    def __str__(self):
+        return "{} ({})".format(self.url, self.title)

canvasapi/new_quiz.py

@@ -29,6 +29,34 @@ def delete(self, **kwargs):
 
         return NewQuiz(self._requester, response_json)
 
+    def set_accommodations(self, accommodations, **kwargs):
+        """
+        Apply accommodations at the quiz level for students in a specific assignment.
+
+        :calls: `POST /api/quiz/v1/courses/:course_id/quizzes/:assignment_id/accommodations \
+        <https://developerdocs.instructure.com/services/canvas/resources/new_quizzes_accommodations#method.new_quizzes-accommodation_api.quiz_level_accommodations>`_
+
+        :param accommodations: A list of dictionaries containing accommodation details
+            for each user. Each dictionary must contain `user_id` and can optionally include
+            `extra_time`, `extra_attempts`, and/or `reduce_choices_enabled`.
+        :type accommodations: list of dict
+
+        :returns: AccommodationResponse object containing the status of the accommodation request.
+        :rtype: :class:`canvasapi.new_quiz.AccommodationResponse`
+        """
+        endpoint = "courses/{}/quizzes/{}/accommodations".format(
+            self.course_id, self.id
+        )
+
+        response = self._requester.request(
+            "POST",
+            endpoint,
+            _url="new_quizzes",
+            _kwargs=combine_kwargs(**kwargs),
+            json=accommodations,
+        )
+        return AccommodationResponse(self._requester, response.json())
+
     def update(self, **kwargs):
         """
         Update a single New Quiz for the course.
@@ -51,3 +79,8 @@ def update(self, **kwargs):
         response_json.update({"course_id": self.course_id})
 
         return NewQuiz(self._requester, response_json)
+
+
+class AccommodationResponse(CanvasObject):
+    def __str__(self):
+        return f"{self.message}"