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
File details
Details for the file ic_parent_api-0.0.15.tar.gz
.
File metadata
- Download URL: ic_parent_api-0.0.15.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3abee2a00104695b21d0724d8434f4319e9882c9a8ab6b8c767fc655f4f4de6a |
|
MD5 | d4319ee57dfca8bde9492f03add90bdb |
|
BLAKE2b-256 | d07977e924bb4f9cc13d492e41a6c47b411c87bd729d7e0be5c23e52f036ec5c |
File details
Details for the file ic_parent_api-0.0.15-py3-none-any.whl
.
File metadata
- Download URL: ic_parent_api-0.0.15-py3-none-any.whl
- Upload date:
- Size: 14.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3de34a90af02b560a937a4cf89be958259c64ce165a99f97647668759bd60b8e |
|
MD5 | 502fde082f7a3c5266be31d8652ba1bd |
|
BLAKE2b-256 | bcc020e4985e56ae9e7991d997f598dd748f406a1dab31866d02a36a88f0da6c |