A small async API wrapper for Infinite Campus Parents.
Project description
Infinite Campus Parent API
This is an async wrapper for the Infinite Campus API. There are a few types of objects this will retrieve based on the assumption that you are a parent with students enrolled with Canvas.
The types of objects that can be returned include:
- Students
- Courses
- Assignments
- Terms
This module is provided for use with the Home Assistant custom integration Infinite Campus however it could be useful as a standalone module for your own projects as well.
Installing
To install the module use:
python3 -m pip install ic-parent-api
Usage
At the login page inspect the page with developer tools and search for the hidden input with the name appName
. Like in the image below.
Example usage to get students, printing first names:
import asyncio
from ic_parent_api import InfiniteCampus
base_url = "https://school.infinitecampus.com"
username = "myusername"
password = "myp4ssw0rd!"
district = "schooldistrict" #known as appName to infinitecampus
async def get_students():
client = InfiniteCampus(f"{base_url}",f"{username}",f"{password}",f"{district}")
return await client.students()
students = asyncio.run(get_students())
for student in students:
print(student.firstname)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ic_parent_api-0.0.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10b22f910bfb4b9b71e4118848c29584f682c395d1565451d9adfbe9d157bc85 |
|
MD5 | 99208a697c81d0f8e3fa868bf8cdff74 |
|
BLAKE2b-256 | 227a2b44edc6406cda33847a365a2ec0895f14106c5076f843f2bf12cb26df36 |