https://github.com/tascord/compass-edu

An unoficcial API for compass.education, using puppeteer
https://github.com/tascord/compass-edu

compass-education nodejs puppeteer

Last synced: 3 months ago
JSON representation

An unoficcial API for compass.education, using puppeteer

• Host: GitHub
• URL: https://github.com/tascord/compass-edu
• Owner: tascord
• License: mit
• Archived: true
• Created: 2020-02-04T04:15:57.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-08T07:08:22.000Z (over 1 year ago)
• Last Synced: 2024-09-25T08:26:34.733Z (3 months ago)
• Topics: compass-education, nodejs, puppeteer
• Language: JavaScript
• Homepage:
• Size: 125 KB
• Stars: 8
• Watchers: 5
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Compass-edu

=========

An unofficial api for [Compass](https://compass.education) using [puppeteer](https://github.com/puppeteer/puppeteer)!!

## Installation

  `npm install compass-edu`

## Usage

[Read The Docs](https://tascord.gitbook.io/compass-edu/)

```

    var Compass = require('compass-edu');

    var user = new Compass('school_prefix');

  

    user.on('initialized', async () => { user.login({username: 'username', password: 'password'});

```

## Examples

Examples can be located in [/examples/](https://github.com/tascord/compass-edu/tree/master/exmaples).

The current examples are:

  * [Basic Class Fetcher](https://github.com/tascord/compass-edu/blob/master/exmaples/getClasses.js)

## Contributing

Please feel free to contribute, either by Creating A Fork, [Submitting A Feature Request](https://github.com/tascord/compass-edu/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=) or [Submitting A Bug Report](https://github.com/tascord/compass-edu/issues/new?assignees=&labels=bug&template=bug_report.md&title=).