powerschool-api
v1.1.0
Published
A Node.js library for interacting with the PowerSchool API.
Downloads
16
Maintainers
Readme
PowerSchool API for Node.js
A Node.js library for interacting with the PowerSchool API.
We currently support fetching a variety of data on the user. Due to a lack of testing resources, we currently only support read operations. There are no API calls that modify user data or submit any information other than logging in.
Installation
Node 7.0.0 or later is required to use this package.
To install using NPM, type: npm install powerschool-api --save
Example Usage
The provided Test script actually provides a pretty good example of how you would log a user in and fetch data like their courses. Check it out for a quick getting started example.
Full Documentation
To take full advantage of the package, check out the documentation and see of the methods and variables that are made available to you.
Contributing
This library is nowhere near completion, as useful as it currently is for retrieving information. If you can, you're encouraged to contribute and make a pull request.
If you find an issue in the code or while using it, create an issue.
License
This project is licensed under the MIT license. Please make sure you comply with its terms while using the library.