Skip to content

grantholle/node-powerschool

Repository files navigation

[WIP] Node PowerSchool API Wrapper

A powerful API wrapper for PowerSchool's API. This is a port to Node from the PHP package grantholle/powerschool-api.

Backlog

Below are the features that should be included:

  • Fetching token
  • Setting table
  • Setting method
  • Setting endpoint
  • Setting ID
  • Projection management
  • Setting data
  • Setting query params
  • Setting query expression
  • Setting filter
  • Setting projection
  • Setting page
  • Setting page size
  • Setting sort
  • Setting order
  • Including count
  • Including expansions
  • Including extensions
  • Retrieving count
  • Sending request
  • Pagination

Getting Started

Install it in your project:

npm install node-powerschool

Usage

Coming soon.

Available Scripts

  • clean - remove coverage data, Jest cache and transpiled files,
  • prebuild - lint source files and tests before building,
  • build - transpile TypeScript to ES6,
  • build:watch - interactive watch mode to automatically transpile source files,
  • lint - lint source files and tests,
  • prettier - reformat files,
  • test - run tests,
  • test:watch - interactive watch mode to automatically re-run tests

License

Licensed under the APLv2. See the LICENSE file for details.