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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ic_parent_api_btk-0.0.15.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.15.tar.gz
Algorithm Hash digest
SHA256 2ffacf6843f6c91590d74c0ae06dfbe4dcade3535c41f974915949969eb6a6d3
MD5 dcad343c1646be768fe1911c7bcbd4b4
BLAKE2b-256 6bed9a73cb49cf648f79f9eee4455fa6ce565d72b8f21aa96153ab8772f83bd9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ic_parent_api_btk-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 4fcdcb1669ec92394403e13ac45310eeda45b7d2361ca4e8a397530969484346
MD5 a3232ab1ee560a2987f12f9d918ee96d
BLAKE2b-256 60f4979a155324962ca6ea4e89f03cbe3cc470369499379121b31aa0c6cf4e87

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