3.3.0 - 2023-08-27

General

• Added documentation for PaginatedList
• Rework requester URLs to accomodate graphql and new quizzes endpoints (Thanks, @bennettscience)

Bugfixes

• Fixed PaginatedList not respecting new quizzes endpoints (Thanks, @matthewf-ucsd)

Backstage

• Updated codecov action

3.2.0 - 2023-05-25

New Endpoint Coverage

• New Quizzes
• Delete Page in Groups (Thanks, @Caitlin-Fabian)

General

• Added support for pagination with metadata when headers are missing (Thanks, @bennettscience)
• Added support for Python 3.11

Bugfixes

• Fixed an issue where Course.create_discussion_topic wouldn't accept attachment files.

3.1.0 - 2023-04-21

New Endpoint Coverage

• Account Calendars (Thanks, @dmols)
  • List available account calendars
  • Get a single account calendar
  • Update a calendar's visibility
  • Update many calendars' visibility
  • List all account calendars
• Enrollments (Thanks, @svanderwulp)
  • Accept Course Invitation
  • Reject Course Invitation
• File (Thanks, @bennettscience)
  • Update File
• JWTs (Thanks @dmols)
  • Create JWTs
  • Refresh JWTs
• Moderation Grading (Moderation Set)
  • List students selected for moderation
  • Select students for moderation
• Query Course Events (Thanks, @dmols)
  • Query by course
  • Query by account
• Rubrics (Thanks, @bennettscience)
  • Create, Update, and Delete Rubric Assessments
  • Create a Rubric Association
• Users
  • Terminate all user sessions (Thanks, @lucas-salas)

General

• Updated Codecov action to v3

Bugfixes

• Fixed an issue where kwargs were not passed along to Canvas in Course.get_module(). (Thanks, @bennettscience)
• Fixed an issue where not all functions allowed arbitrary keyword arguments. Added a test to detect and prevent this for the future.
• Fixed an issue with Course.get_enabled_features() where it would throw an error trying to paginate. It now returns a list of strings directly. (Thanks, @bennettscience)
• Added missing docs for AssignmentOverride. (Thanks, @lafent)
• Fixed a typo in Canvas.create_calendar_event() where an error message improperly listed the missing key as 'context_codes' instead of 'context_code'. (Thanks, @dmols and @mikesuhan)

3.0.0 - 2022-09-21

New Endpoint Coverage

• Delete a Rubric (Thanks, @ggarfink)
• Grade Change Log for Assignments, Courses, and Users (Thanks, @matthewf-ucsd)
• Content Migrations: List items for selective import (Thanks, @matthewf-ucsd)
• List observers of a User (Thanks, @bennettscience)
• ePortfolio endpoints (Thanks, @Birdmaaan4 and @bennettscience)
• Delete an Admin from an Account (Thanks, @shaneros)

General

• Added support for Python 3.10
• Smart DateTimes now support any ISO 8601 format, including time offsets. (Thanks, @kailukaitisBrendan)

Bugfixes

• Fixed an issue where kwargs were not passed along to Canvas in User.get_profile(). (Thanks, @breed)

Breaking Changes

• Dropped support for Python 3.6
• Update QuizSubmission.get_submission_events to return a PaginatedList. (Thanks, @stevenbell)
• Update Course.get_course_level_student_summary_data to return a PaginatedList of CourseStudentSummary items instead of a dictionary. (Thanks, @craigdsthompson)
• Update Course.get_outcome_results to return a PaginatedList of OutcomeResult items instead of a dictionary. (Thanks, @bennettscience)
• Remove unnecessary id parameter from delete, reorder_question_group, and update methods in QuizGroup class. (Thanks, @kailukaitisBrendan)
• Update Submission to return attachments as File objects instead of dictionaries. (Thanks, @laitingsheng)

2.2.0 - 2021-03-25

New Endpoint Coverage

• Enroll a user in a section (Thanks, @damianfs)
• File quota for courses, groups, and users (Thanks, @deundrewilliams)
• Provisional Grades (Thanks, @zenith110)

General

• Added support for Python 3.9
• Added RateLimitExceeded exception to distinguish between being rate limited and being otherwise forbidden from accesing a resource. It is a subclass of the Forbidden exception.
• File uploads now accept path-like objects (Thanks, @theunkn0wn1)
• Add list of CanvasAPI Projects to README (Thanks, @deundrewilliams)
• PyPI Package Description now uses README (Thanks, @bennettscience)
• Replaced Travis CI with GitHub Actions

Bugfixes

• Fixed an issue where Canvas.create_poll() did not work due to an incorrect parameter.
• Canvas.get_todo_items() now correctly returns a PaginatedList of Todo items (Thanks, @bennettscience)
• Fixed an issue where Favorite.remove() did not handle parameters properly. (Thanks, @deundrewilliams)

2.1.0 - 2020-12-04

New Endpoint Coverage

• Course TODO items (Thanks, @onomou)
• Create observer pairing code (Thanks, @bennettscience)

General

• Added missing documentation for the get_current_user method and clarifications to the CurrentUser class. (Thanks, @Xx-Ashutosh-xX)
• Canvas.get_announcement now has a required parameter context_codes, which accepts a list of course IDs or Course objects.
• Updated contributing guide
• Added missing documentation for the "Smart DateTimes" feature
• Added basic troubleshooting guide to documentation

Bugfixes

• Fixed an issue where an Announcement object sometimes didn't have an associated course ID. (Thanks, @bennettscience)
• Fixed an issue where an encoding problem could lead to file downloads hanging indefinitely. (Thanks, @blepabyte)

Deprecation Warnings

• The enrollment_type argument on Course.enroll_user is now deprecated. Pass this information to enrollment[type] as a keyword argument instead. e.g. enroll_user(enrollment={'type': 'StudentEnrollment'})

2.0.0 - 2020-08-14

General

• Added support for arbitrary keyword arguments across the entire library

New Endpoint Coverage

• Custom Gradebook Columns (Thanks,@aileenpongnon)
• Files
  • Resolve Path (Thanks,@dsavransky)

Bugfixes

• Fixed an issue where Quiz.get_quiz_group incorrectly set course_id to the quiz ID. (Thanks,@hcolclou)
• Fixed an issue where Course.create_external_tool didn't accept client_id (LTI 1.3 support).
• Fixed an issue where Module.create_module_item didn't (Thanks,@aileenpongnon and @onomou)
• Fixed an issue where Page.revert_to_revision would incorrectly always set group_id to the page ID. Now correctly sets group_id or course_id appropriately.

Breaking Changes

• Course.create_external_tool no longer supports positional arguments for its required parameters. Use keyword arguments instead.

1.0.0 - 2020-07-09

General

• Added support for Python 3.8
• Dropped support for Python 3.4, 3.5, and 2.7
• Removed all previously deprecated methods and attributes.
• Upgraded Ubuntu version for Travis (Thanks, @jonespm)
• Set up automatic deployments to PyPI via Travis
• Set up nightly build

0.16.1 - 2020-07-06

Bugfixes

• Fixed an issue where the user-provided API_URL/base_url wasn't run through cleanup.

Deprecation Warnings

• Using /api/v1/ in the API_URL has been deprecated since v0.8.0 and legacy support will be removed in the next release. Ensure your provided url doesn't contain api/v1/. See deprecation warning in changelog for v0.8.0.
• ⚠️ This is the final release with support for Python 3.5 ⚠️

0.16.0 - 2020-06-26

New Endpoint Coverage

• Enrollment Terms
  • Get a Single Enrollment Term (Thanks, @lcamacho)
• Files
  • Resolve Path for Course (Thanks,@dsavransky)
• GraphQL (Thanks,@jonespm)
• Late Policy (Thanks, @kennygperez)
• Quiz Assignment Overrides (Thanks, @kennygperez)
• Quiz Statistics (Thanks, @andrew-gardener)

General

• Updated README to use updated parameters for getting a user's courses by enrollment state (Thanks,@Vishvak365)

Deprecation Warnings

• ⚠️ This is the final release with support for Python 2.7 ⚠️
  • Python 2.7 is end-of-life as of January 2020
  • Future releases of CanvasAPI will NOT support any version of Python 2
• ⚠️ This is the final release with support for Python 3.4 ⚠️
  • Python 3.4 is end-of-life as of March 2019
  • Future releases of CanvasAPI will NOT support Python 3.4 or below
• This is the final deprecation warning for all methods marked as deprecated in this changelog or in our documentation. They will be removed in the next release.

Bugfixes

• Fixed an issue where Quiz.get_submission() ignored data added from using the include kwarg. (Thanks,@Mike-Nahmias)
• Fixed the broken __str__ method on the ChangeRecord class (Thanks,@Mike-Nahmias)
• Fixed an issue where printing an AccountReport would fail due to not having an ID (Thanks,@Mike-Nahmias)
• Fixed an issue where "report_type" was passed improperly (Thanks,@brucespang)
• Fixed some new flake8 issues (Thanks,@dsavransky and @jonespm)
• Fixed an incorrect docstring for Course.create_page() (Thanks,@dsavransky)
• Fixed an issue where extra whitespace in the user-supplied canvas URL would break PaginatedList (Thanks,@amorqiu)