Skip to main content

A Python Wrapper for use with the Infinite Campus API

Project description

InfiniteCampusAPI

Example:

from infinitecampusapi import InfiniteCampus

test = InfiniteCampus(
    token_url="https://iacloud2.infinitecampus.org/campus/oauth2/token?appName=example",
    base_url="https://iacloud2.infinitecampus.org/campus/api/oneroster/v1p2/example/ims/oneroster/rostering/v1p2/",
    secret="api_secret",
    key="api_key",
)
print(test.students.get_students())
print(test.student.get_student("12345678-1234-1234-1234-1234567890ab"))
print(test.teachers.get_teachers())
print(test.teachers.get_teacher("12345678-1234-1234-1234-1234567890ab"))
print(test.schools.get_schools())
print(test.schools.get_school("12345678-1234-1234-1234-1234567890ab"))
print(test.schools.get_school_students("12345678-1234-1234-1234-123456789ab"))
print(test.demographics.get_demographics())
print(test.demographics.get_demographic("12345678-1234-1234-1234-1234567890ab"))
print(test.student.get_student_demographics(test.students.get_students()[0]))
print(test.academicSessions.get_academic_sessions())
print(test.academicSessions.get_academic_session("12345678-1234-1234-1234-1234567890ab"))
print(test.courses.get_courses())
print(test.courses.get_course("12345"))
print(test.courses.get_course_classes("12345"))
print(test.enrollments.get_enrollments())
print(test.enrollments.get_enrollment("s12345678"))
print(test.gradingPeriods.get_grading_periods())
print(test.gradingPeriods.get_grading_period("12345678-1234-1234-1234-1234567890ab"))
print(test.orgs.get_orgs())
print(test.orgs.get_org("12345678-1234-1234-1234-1234567890ab"))
print(test.schools.get_school_classes("12345678-1234-1234-1234-1234567890ab"))
print(test.schools.get_school_class_groups("12345678-1234-1234-1234-1234567890ab"))
print(test.schools.get_school_courses("12345678-1234-1234-1234-1234567890ab"))
print(test.schools.get_school_enrollments("12345678-1234-1234-1234-1234567890ab"))
print(test.schools.get_school_teachers("12345678-1234-1234-1234-1234567890ab"))
print(test.schools.get_school_terms("12345678-1234-1234-1234-1234567890ab"))
print(
    test.schools.get_school_class_enrollments(
        "12345678-1234-1234-1234-1234567890ab", "12345"
    )
)
print(
    test.schools.get_school_class_students(
        "12345678-1234-1234-1234-1234567890ab", "12345"
    )
)
print(
    test.schools.get_school_class_teachers(
        "12345678-1234-1234-1234-1234567890ab", "12345"
    )
)
print(test.terms.get_terms())
print(test.terms.get_term("123"))
print(test.terms.get_term_classes("123"))
print(test.terms.get_term_grading_periods("123"))
print(test.users.get_users())
print(test.users.get_user("12345678-1234-1234-1234-1234567890ab"))
print(test.users.get_user_classes("12345678-1234-1234-1234-1234567890ab"))

# Filtering available on get_students
print(test.students.get_students(filters="familyName='Doe' AND givenName='John'"))

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

infinitecampusapi-0.1.1.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

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

infinitecampusapi-0.1.1-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

Details for the file infinitecampusapi-0.1.1.tar.gz.

File metadata

  • Download URL: infinitecampusapi-0.1.1.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.13.2 Darwin/24.5.0

File hashes

Hashes for infinitecampusapi-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fa85d8f011e6a1259765633ffbc8022131e2973c80d078067ae24c5f7565ec20
MD5 786e5ec5f57f860663a5e34b6cc1a64a
BLAKE2b-256 b3fb435736286ec3470c19bd03b2383748ae879319ee71f8cb95ec8a00d57ec4

See more details on using hashes here.

File details

Details for the file infinitecampusapi-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: infinitecampusapi-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.13.2 Darwin/24.5.0

File hashes

Hashes for infinitecampusapi-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2946a01366248aa905960a166d5aa507fdaba18fff4619f1011dcf5886d7d74f
MD5 cffe51fed2fbbfcc54cc17b9555eef7d
BLAKE2b-256 c20d55079b0366adf6a7ef6066ca3ff082a19fcd31198de1755069393541283b

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