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.16.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.16-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ic_parent_api_btk-0.0.16.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.16.tar.gz
Algorithm Hash digest
SHA256 e21c111164ac28cd9f8834263a7e1af5dfb0a42f96b8c5ef229fb34ad4e456d1
MD5 ae164adece31ca841c3f29d59fb7acb8
BLAKE2b-256 9ed120249015298cd3724aa41968d8d0aac3185ab384403df9aed7d9b708b37e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ic_parent_api_btk-0.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 5a4cd9c84d2096b331790d78ba1713435884fd0ccf193033e38a70749b7c5779
MD5 b8c9a1a5a8dd35096310637d0508e552
BLAKE2b-256 c5726c3de02b46696c0f2b4f1b706565d4d1155dd13dd141cd51022cd360c3e8

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