Skip to content

Commit

Permalink
Merge pull request #9 from babikoffb/master
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
cbini authored Jun 9, 2021
2 parents 9cc7281 + 033d7bc commit 382ce1c
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# PowerSchool
powerschool is a Python client for the [PowerSchool SIS](https://www.powerschool.com/solutions/student-information-system/powerschool-sis) API

## Table of Contents

* [Installation](#installation)
* [Generate Client ID and Client Secret](#generate-client-id-and-client-secret)
* [Getting Started](#getting-started)
* [Usage](#usage)
* [Contributing](#contributing)
* [Notice](#notice)

## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install powerschool.
```bash
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](https://support.powerschool.com/developer/#/page/plugin-xml) installed with the proper data access provisioned for your purposes.
Expand Down

0 comments on commit 382ce1c

Please sign in to comment.