chawk 0.1.1

An API wrapper library for the Blackboard LMS.

Chawk

This project is a work in progress.
A python wrapper of the blackboard api to simplify admin tasks such as managing courses.

Setup

You will need to create an application to get the needed keys. You can request access to the Blackboard REST APIs through the Developer Portal.

Example of using the library

from chawk.blackboard_client import BlackboardClient


base_url = "https://blackboard.xxxx.edu"
client_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
client_secret = "xxxxxxxxxxxxxxxxxxxxxxxxx"

# Create client
client = BlackboardClient(client_id, client_secret, base_url, "example.log")

# Example usage
print(client.user.does_user_exist("00000_0"))
print(client.courses.does_course_exist("00000_1"))

client.courses.enroll_user(username="wilson1234", course_id="ge.math101213", role="Student")

Current Functions

User

   create_user(username: str, f_name: str, l_name: str, email: str, password: str) -> None:
   does_user_exist(username: str) -> bool:
   update_email(username: str, email: str) -> None:
   update_availability(username: str, availability: str) -> None:
   update_data_source(username: str, data_source_id: str) -> None:
   get_course_role(username: str, course_id: str) -> str:
   add_institution_roles(username: str, roles: list) -> None:
   get_enrollments(username: str) -> list[BBCourse]:

Course

Discussion

Gradebook

- Update column value for user
- Create column