https://github.com/cthacker-udel/python-canvas-api-wrapper

Python wrapper of Canvas API
https://github.com/cthacker-udel/python-canvas-api-wrapper

api-rest python requests

Last synced: 3 months ago
JSON representation

Python wrapper of Canvas API

• Host: GitHub
• URL: https://github.com/cthacker-udel/python-canvas-api-wrapper
• Owner: cthacker-udel
• Created: 2021-07-22T07:04:30.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-10-09T10:49:56.000Z (over 3 years ago)
• Last Synced: 2025-02-07T17:39:04.570Z (5 months ago)
• Topics: api-rest, python, requests
• Language: Python
• Homepage:
• Size: 4.21 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Unofficial Python Canvas-LMS Wrapper

> Author : Cameron Thacker ([email protected])

> This wrapper centers around two files, CanvasClient and CanvasRestAPI, both which do most of the handling. Implementing the sub-classes that are implemented to store the variables and values used in requests differeing from POST to PUT to GET, allows for ease of integration if one method does not successfully complete, then instead of looking at a file of 1000 lines, you can examine a single file of 100 lines and discern which variable was incorrect or if the field was passed.

Each storage class (*classes besides CanvasClient and CanvasRestAPI*), implements two methods: 

1. **generate_queries(no args)** 

2. **clear_queries(no args)**

* **generate_queries(no args)** accesses all the class's attributes and constructs a dictionary object which can be passed as json or data via requests interface

* **clear_queries(no args)** clears all attributes (*setting them back to None*) to avoid having conflicts if making separate requests, or the attributes may simply be reset with the dot notation when directly accessing the class from its instantiated state

The following APIs are currently implemented :

* Account API

  * (*CanvasAccount.py*)

* Account Domain Lookup API

  * (*CanvasAccountDomainLookup.py*)

* Account Notifications API

  * (*CanvasAccountNotifications.py*)

* Account Report API

  * (*CanvasAccountReport.py*)

* Admin API

  * (*CanvasAdmin.py*)

* Analytics API

  * (*CanvasAnalytics.py*)

* Announcements API

  * (*CanvasAnnouncements.py*)

* Assignment Extensions API

  * (*CanvasAssignmentExtensions.py*)

* Assignment Groups API

  * (*CanvasAssignmentGroups.py*)

* Assignments API

  * (*CanvasAssignments.py*)

* External Feed API

  * (*CanvasExternalFeed.py*)

* Token Scopes API

  * (*CanvasTokenScopes.py*)

---

> Source : https://canvas.instructure.com/doc/api/