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-0.0.16.tar.gz (12.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-0.0.16-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ic_parent_api-0.0.16.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

Hashes for ic_parent_api-0.0.16.tar.gz
Algorithm Hash digest
SHA256 49df509d296002e78f3f1214ab8aa3bf5cde4ae8ffd659c9b710f2da61f3fa82
MD5 6f7b4a23e951bdf4486c25be6998d860
BLAKE2b-256 fd376b9514a52aeeeb4f925472a079d57632327620d96d70873734323392434c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ic_parent_api-0.0.16-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

Hashes for ic_parent_api-0.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 2dff3e42957039e8f9c867d84237afbc829a5cf442310c7e5ac0cba6fbc4d84d
MD5 bac82376cf642ff4adba35e37320d7d1
BLAKE2b-256 ba138f9db051adbe20da4e68c558762251cfa30fced8efac65861857923c1b06

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