Skip to content

sandboxnu/course-catalog-api-cache

Repository files navigation

The Course Catalog API Cache

Note

To scrape from Banner, use the scrapers/main.ts file found in the course catalog API. It's very simple and easy to use - with no environment variables, it scrapes the past 12 class terms by default; otherwise, you can provide a custom amount of terms to scrape with the NUMBER_OF_TERMS variable or a custom list of terms with the TERMS_TO_SCRAPE variable! To get the specific term IDs to scrape for a given year, use the included scrape.py file!

Overview/FAQs

  • What is a "course catalog API"?
    • The course catalog API is an API to access Northeastern University's course catalog (containing section, class, and employee data).
  • So what's a "course catalog API cache"?
    • Read the documentation here. If this link is dead, we may have changed the doc structure, so just go to apidocs.searchneu.com and search for "cache".
    • Long story short - it caches our scrapers' network requests to Banner, Northeastern's official course catalog. Our calls are rate-limited, so for development purposes, we cache those requests to make it easier for devs.
  • How can I use this?
    • See the documentation link above
  • How can I combine caches?
    • Run them one by one (ie. import one cache, run yarn scrape, delete the cache, and import the next). Every time you run yarn scrape, the data in your database will be updated with the new data (but will keep the old data as well).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages