Skip to content
This repository has been archived by the owner on Dec 13, 2020. It is now read-only.
/ powerschool-api Public archive
forked from aydenp/PowerSchool-API

A Node.js library for interacting with the PowerSchool API.

License

Notifications You must be signed in to change notification settings

whsha/powerschool-api

 
 

Repository files navigation

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.

You must setup gpr following the instructions here

To install using NPM, type: npm install @whsha/powerschool-api --save
To install using Yarn, type: yarn add @whsha/powerschool-api

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.

Documentation

To take full advantage of the package, check out the documentation and see all of the methods and variables that are made available to you.

Contributing

Feel free to contribute to the source code of this project to make it something even better! Just try to adhere to the general coding style throughout, to make it as readable as possible.

If you find an issue in the code or while using it, create an issue. If you can, you're encouraged to contribute and make a pull request.

License

This project is licensed under the MIT license. Please make sure you comply with its terms while using it in any way.

Links

About

A Node.js library for interacting with the PowerSchool API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • JavaScript 100.0%