Skip to main content

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.

Screenshot 2022-09-16 171957

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ic_parent_api_btk-0.0.17.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ic_parent_api_btk-0.0.17-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file ic_parent_api_btk-0.0.17.tar.gz.

File metadata

  • Download URL: ic_parent_api_btk-0.0.17.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.7

File hashes

Hashes for ic_parent_api_btk-0.0.17.tar.gz
Algorithm Hash digest
SHA256 f503a61a0011cd38cb5fa384663199d7a6059dd02639b7b9fdffe108da44fc19
MD5 8c2b5ebc3de61f447a1fb13a7ec15f9e
BLAKE2b-256 c81f171d0a4dedd400158950b2b277a3b41aa975e1396f781316912c2f7659bf

See more details on using hashes here.

File details

Details for the file ic_parent_api_btk-0.0.17-py3-none-any.whl.

File metadata

File hashes

Hashes for ic_parent_api_btk-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 554fb3a2d0dfff4a570e28af34a16256fef6e0bf18e0bc175297694529ff5323
MD5 13bb575eeab8b29866c18dd6a06c68ae
BLAKE2b-256 26865349bce37aed81e4f03b9f787352a4a368e102d1e9b07b13018f2a687c64

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page