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.18.tar.gz (12.9 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.18-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ic_parent_api_btk-0.0.18.tar.gz
  • Upload date:
  • Size: 12.9 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.18.tar.gz
Algorithm Hash digest
SHA256 be45d4359365a5b52dc4f46479a8713dea9caedc477a3044024a7d860167bc26
MD5 f77a17dd8615e69f7676b085bfaf9887
BLAKE2b-256 e5836c71e78b4953a08e3256ea44ef603ea8ec63942a193daf830ddea5ed396a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ic_parent_api_btk-0.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 aa0e1a1ea4f85137cbd0beab20da70deef0f2b60d26122f4a99241f5f75e74df
MD5 d6220bbe7c41f0949beb194f9043dac3
BLAKE2b-256 8afe9c05e40a8e0642dbcf1543a3dd443b879bfc8be6a0ab0ed9380c113e16c8

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