| Name | chawk JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | An API wrapper library for the Blackboard LMS. |
| upload_time | 2025-08-20 00:01:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
api
blackboard
lms
wrapper
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Chawk
**This project is a work in progress.**<br>
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](https://developer.blackboard.com/).
# Example of using the library
```python
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
```python
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
```markdown
```
## Discussion
```markdown
```
## Gradebook
```markdown
- Update column value for user
- Create column
```
Raw data
{
"_id": null,
"home_page": null,
"name": "chawk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "api, blackboard, lms, wrapper",
"author": null,
"author_email": "sugarvoid <author@example.com>",
"download_url": "https://files.pythonhosted.org/packages/4f/f7/217c8a98993fdfce7ec4aea7813e2376e2e30dbfbf87f8a5260005746746/chawk-0.1.3.tar.gz",
"platform": null,
"description": "# Chawk \n\n**This project is a work in progress.**<br>\nA python wrapper of the blackboard api to simplify admin tasks such as managing courses. \n\n# Setup \nYou will need to create an application to get the needed keys. You can request access to the Blackboard REST APIs through the [Developer Portal](https://developer.blackboard.com/). \n\n\n# Example of using the library \n```python\n\nfrom chawk.blackboard_client import BlackboardClient\n\n\nbase_url = \"https://blackboard.xxxx.edu\"\nclient_id = \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\nclient_secret = \"xxxxxxxxxxxxxxxxxxxxxxxxx\"\n\n# Create client\nclient = BlackboardClient(client_id, client_secret, base_url, \"example.log\")\n\n# Example usage\nprint(client.user.does_user_exist(\"00000_0\"))\nprint(client.courses.does_course_exist(\"00000_1\"))\n\nclient.courses.enroll_user(username=\"wilson1234\", course_id=\"ge.math101213\", role=\"Student\")\n```\n\n# Current Functions \n\n## User\n ```python\n create_user(username: str, f_name: str, l_name: str, email: str, password: str) -> None:\n does_user_exist(username: str) -> bool:\n update_email(username: str, email: str) -> None:\n update_availability(username: str, availability: str) -> None:\n update_data_source(username: str, data_source_id: str) -> None:\n get_course_role(username: str, course_id: str) -> str:\n add_institution_roles(username: str, roles: list) -> None:\n get_enrollments(username: str) -> list[BBCourse]:\n\n```\n\n## Course\n\n```markdown\n\n```\n\n## Discussion\n```markdown\n\n```\n\n## Gradebook\n```markdown\n\n- Update column value for user\n- Create column\n\n```",
"bugtrack_url": null,
"license": null,
"summary": "An API wrapper library for the Blackboard LMS.",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/sugarvoid/chawk",
"Issues": "https://github.com/sugarvoid/chawk/issues"
},
"split_keywords": [
"api",
" blackboard",
" lms",
" wrapper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b25aeeaf17ec05dc5cb5d02b07d3824186db2d884f63b5c6bf3f6ad53dca73c1",
"md5": "5f76f2eeb4142987b290d8b9ceffe1fc",
"sha256": "bf914e2ebe04943bc78a1c330d01331e94a5e6f7eb4613b16ca1b83cad3a7179"
},
"downloads": -1,
"filename": "chawk-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f76f2eeb4142987b290d8b9ceffe1fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 18684,
"upload_time": "2025-08-20T00:01:24",
"upload_time_iso_8601": "2025-08-20T00:01:24.085573Z",
"url": "https://files.pythonhosted.org/packages/b2/5a/eeaf17ec05dc5cb5d02b07d3824186db2d884f63b5c6bf3f6ad53dca73c1/chawk-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4ff7217c8a98993fdfce7ec4aea7813e2376e2e30dbfbf87f8a5260005746746",
"md5": "086187439ccd16797dfc281bd16e2cb6",
"sha256": "90ffe83368b252a681e12b475e269c33718956d1cd0ab4072ce5e8d75f05e390"
},
"downloads": -1,
"filename": "chawk-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "086187439ccd16797dfc281bd16e2cb6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 15953,
"upload_time": "2025-08-20T00:01:25",
"upload_time_iso_8601": "2025-08-20T00:01:25.575622Z",
"url": "https://files.pythonhosted.org/packages/4f/f7/217c8a98993fdfce7ec4aea7813e2376e2e30dbfbf87f8a5260005746746/chawk-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-20 00:01:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sugarvoid",
"github_project": "chawk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chawk"
}
