Skip to content

Latest commit

 

History

History
113 lines (74 loc) · 2.93 KB

README.md

File metadata and controls

113 lines (74 loc) · 2.93 KB
Raw

PowerSchool

powerschool is a Python client for the PowerSchool SIS API

Table of Contents

Installation

Use the package manager pip to install powerschool.

pip install powerschool

Generate Client ID and Client Secret

You can collect the Client ID and Client Secret directly by signing into the PowerSchool Admin portal and navigating to System > System Settings > Plugin Management Dashboard > {Your Plugin}.

Getting Started

  1. Ensure you have a valid plugin installed with the proper data access provisioned for your purposes.

  2. Instantiate a client by passing the host name of your server and one form of authentication:

    • client credentials (tuple)
     import powerschool

 client_id = 'CLi3N7-Id'
 client_secret = 'cL13N7-53cR37'
 my_credentials = (client_id, client_secret)

 ps = powerschool.PowerSchool('my.host.name', auth=my_credentials)
    • access token (dict)
     import powerschool

 with open('/path/to/token_file.json', 'r') as f:
     my_token = json.load(f)

 ps = powerschool.PowerSchool('my.host.name', auth=my_token)

Usage

Refer to the docs for full functionality, including resources, searching, and pagination.

Instantiate a table or PowerQuery object:

schools_table = ps.get_schema_table('schools')

powerquery = ps.get_named_query('com.pearson.core.student.search.get_student_basic_info')

Get the record count for a table:

schools_table.count()

Query all records, all columns on a table:

Pagination is handled automatically by the client. However, you can manually pass pagesize and page parameters, should you choose.

schools_table.query()

Query all records on a table, with filter and columns list:

params = {
    'q': 'id=ge=10000',
    'projection': 'school_number,abbreviation',
}
schools_table.query(**params)

Query a specific record on a table:

schools_table.query(pk=123)

Execute a PowerQuery, passing arguments in the body:

payload = {
    'studentdcid': '5432',
}
powerquery.query(body=payload)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Notice

PowerSchool® is a registered trademark in the U.S. and/or other countries owned by PowerSchool Education, Inc. or its affiliates. PowerSchool® is used under license.