Package -

Gradespeed HISD

A package that allows for easy scraping of the GradeBook page's HTML from HISD's GradeSpeed portal.

NPM

Build Status Coverage Status Downloads Greenkeeper

Installation

npm install gradespeed-hisd

Usage

Calling the function returns a Promise object that works as follows:

gradespeed(username, password)
.then(returnArr => {
  // Handle return array of object
})
.catch(error => {
  // Error handling
})

The array returned by the function upon succeeding is:

  • returnArr - An array of objects that contain grade data that was scraped from the GradeBook page.

Tests

npm test

Contributing

Notes

Right now the code is extremely messy and can be improved significantly. Both in function and style. I welcome any suggestions and PR's/issues. It currently seems to be functioning well and properly.

...why?

I recognize that the purpose that this package serves is extremely niche, but I found myself searching and tinkering for hours to figure out how to use a makeshift GradeSpeed API. There is no official API or documentation for it and almost nothing online. Why not make something that at the very least helped me practice making an NPM package and at the most saved someone hours of messing around and bullshit? In response to "...why?", I ask "why not?"

Credits

I could not have done this without the hidden gem that is @au5ton's informal docs page on the GradeSpeed portal.

Github

link
Stars:

Advertisement