vvcanvas0.0.8 package

'Canvas' LMS API Integration

append_access_token

Appends access_token to URL if not present

canvas_api_key

Get the Canvas API key from the environment variable

canvas_authenticate

Authenticate with Canvas LMS API

canvas_base_url

Get the Canvas base URL from the environment variable

create_assignment_group

Create an Assignment Group in Canvas LMS

create_conversation

Creates a new conversation with one or more recipients.

create_course_datalake

Create a data lake for a course.

create_course_section

Create a Course Section in Canvas LMS

create_folder

Create a Folder in Canvas LMS

create_group_category

Create a Group Category in Canvas LMS

create_module_item

Create a Module Item in Canvas LMS

create_module

Create a Module in Canvas LMS

create_page

Create a Page in Canvas LMS

delete_course_section

Delete a Course Section in Canvas LMS

delete_page

Delete a Page in Canvas LMS

download_course_file

Downloads a file from a given URL.

edit_section

Edit a Course Section in Canvas LMS

extract_next_url

Extracts the 'next' URL from a Link header

get_accounts

Get a list of accounts from the Canvas LMS API

get_all_courses

Retrieves a paginated list of all courses visible in the public index.

get_assignment_data

Get course-level assignment data from the Canvas LMS API

get_assignment_details

Get Assignment Details from Canvas LMS API

get_assignment_groups

Retrieves the assignment groups within a course.

get_assignment_submissions

Retrieves assignment submissions.

get_assignments

Get Assignments from Canvas LMS API

get_calendar_events

Get Calendar Events from Canvas LMS API

get_conversations

Retrieves conversations.

get_course_announcements

Retrieves course announcements.

get_course_details

Get Course Details from Canvas LMS API

get_course_enrollments

Retrieves the course enrollments for a course.

get_course_files

Retrieves a list of files within a course.

get_course_folders

Retrieves course folders.

get_course_gradebook

Constructs the gradebook of a course.

get_course_groups

Retrieves the list of groups in a course.

get_course_media_objects

Retrieves the media objects in a course.

get_course_pages

Retrieves the pages within a course.

get_course_participation

Get course-level participation data from Canvas LMS API

get_course_quizzes

Retrieves course quizzes.

get_course_root_folder

Retrieves root folder of a course.

get_course_sections

Retrieves course sections.

get_course_students

Retrieves the list of students in a course.

get_course_users

Retrieves the users in a course.

get_courses

Get Courses from Canvas LMS API

get_department_grade_data

Get department-level grade data from the Canvas LMS API

get_department_participation_data

Get department-level participation data from the Canvas LMS API

get_department_statistics_by_subaccount

Get department-level statistics by subaccount from the Canvas LMS API

get_department_statistics

Get department-level statistics from the Canvas LMS API

get_discussions

Retrieves the discussion topics within a course.

get_favorite_courses

Get Favorite Courses in Canvas LMS

get_folder_files

Retrieves files in a specific folder.

get_group_categories

Get group categories for a context

get_group_info

Get information about a single group

get_group_memberships

Get group memberships

get_group_users

Get users in a group

get_module_items

Retrieves the items within a specific module.

get_modules

Retrieves the modules within a course.

get_page_content

Retrieves the content body of a specified page.

get_quiz_submissions

Retrieves quiz submissions.

get_roles

Retrieve Roles for a Canvas Account

get_section_information

Get Section Information in Canvas LMS

get_section_students

Retrieve Students in a Section

get_single_conversation

Retrieves a single conversation.

get_student_summaries

Get student summaries for a course from Canvas LMS API

get_user_course_assignment_data

Get user-in-a-course-level assignment data from the Canvas LMS API

get_user_course_messaging_data

Get user-in-a-course-level messaging data from the Canvas LMS API

get_user_course_participation_data

Get user-in-a-course-level participation data from the Canvas LMS API

get_user_folders

Retrieves folders of the current user.

get_users

Get all users from an account

list_all_enrollment_terms

List All Enrollment Terms

paginate

Helper to paginate Canvas API GET requests

pipe

Pipe operator

post_new_discussion

Post a New Discussion in Canvas LMS

query_progress

Queries progress.

update_course_grades

Updates assignment grades in a course.

update_page

Update a Page in Canvas LMS

update_quiz

Modify an existing quiz.

update_section_grades

Updates assignment grades in a section.

upload_file

Upload a file in Canvas LMS.

upload_folder_file

Uploads a file to a specific folder.

upload_qti_file_with_migration

Upload QTI File with Content Migration

Allow R users to interact with the 'Canvas' Learning Management System (LMS) API (see <https://canvas.instructure.com/doc/api/all_resources.html> for details). It provides a set of functions to access and manipulate course data, assignments, grades, users, and other resources available through the 'Canvas' API.

  • Maintainer: Hajo Bons
  • License: MIT + file LICENSE
  • Last published: 2026-01-19