{"id":27415879,"url":"https://github.com/michigan-tech-courses/rate-my-professors","last_synced_at":"2025-04-14T09:45:46.712Z","repository":{"id":40277561,"uuid":"326102353","full_name":"Michigan-Tech-Courses/rate-my-professors","owner":"Michigan-Tech-Courses","description":"a basic wrapper for Rate My Professors's GraphQL API","archived":false,"fork":false,"pushed_at":"2023-10-31T08:15:03.000Z","size":513,"stargazers_count":11,"open_issues_count":16,"forks_count":11,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-20T13:19:26.180Z","etag":null,"topics":["api","graphql","ratemyprofessors"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Michigan-Tech-Courses.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-02T03:41:32.000Z","updated_at":"2023-12-23T01:19:11.000Z","dependencies_parsed_at":"2023-02-18T08:45:23.249Z","dependency_job_id":null,"html_url":"https://github.com/Michigan-Tech-Courses/rate-my-professors","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":"codetheweb/typescript-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Michigan-Tech-Courses%2Frate-my-professors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Michigan-Tech-Courses%2Frate-my-professors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Michigan-Tech-Courses%2Frate-my-professors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Michigan-Tech-Courses%2Frate-my-professors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Michigan-Tech-Courses","download_url":"https://codeload.github.com/Michigan-Tech-Courses/rate-my-professors/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248857688,"owners_count":21173011,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","graphql","ratemyprofessors"],"created_at":"2025-04-14T09:45:45.907Z","updated_at":"2025-04-14T09:45:46.705Z","avatar_url":"https://github.com/Michigan-Tech-Courses.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🧑‍🏫 @mtucourses/rate-my-professors\n\n[![codecov](https://codecov.io/gh/Michigan-Tech-Courses/rate-my-professors/branch/master/graph/badge.svg?token=YSBV5T5GVY)](https://codecov.io/gh/Michigan-Tech-Courses/rate-my-professors)\n\nA basic wrapper for Rate My Professors's GraphQL API. Includes TypeScript definitions.\n\nIt is possible to pull full ratings with content as well, but currently this package just returns the average.\n\n## 🏗 Usage\n\n```js\n// Change to \n// const ratings = require('@mtucourses/rate-my-professors').default;\n// if using JS instead of TS\nimport ratings from '@mtucourses/rate-my-professors';\n\n(async () =\u003e {\n  const schools = await ratings.searchSchool('michigan technological university');\n\n  console.log(schools);\n  /*\n    [\n      {\n        city: 'Houghton',\n        id: 'U2Nob29sLTYwMg==',\n        name: 'Michigan Technological University',\n        state: 'MI'\n      }\n    ]\n  */\n\n  const teachers = await ratings.searchTeacher('mtu shene');\n\n  console.log(teachers);\n  /*\n    [\n      {\n        firstName: 'Ching-Kuang',\n        id: 'VGVhY2hlci0yMjkxNjI=',\n        lastName: 'Shene',\n        school: {\n          id: 'U2Nob29sLTYwMg==',\n          name: 'Michigan Technological University'\n        }\n      }\n    ] \n  */\n\n  const teacher = await ratings.getTeacher('VGVhY2hlci0yMjkxNjI=');\n\n  console.log(teacher);\n  /*\n    {\n      avgDifficulty: 4.4,\n      avgRating: 3.3,\n      numRatings: 28,\n      department: 'Computer Science',\n      firstName: 'Ching-Kuang',\n      id: 'VGVhY2hlci0yMjkxNjI=',\n      lastName: 'Shene',\n      school: {\n        city: 'Houghton',\n        id: 'U2Nob29sLTYwMg==',\n        name: 'Michigan Technological University',\n        state: 'MI'\n      },\n      legacyId: 1234567\n    }\n  */\n})();\n```\n\n## 🧰  Development\n\n```bash\n# First:\n# install dependencies\nyarn install\n\n# then:\n# build in watch mode\nyarn build:watch\n\n# and you can:\n\n# run tests\nyarn test\n\n# run tests in watch mode\nyarn test:watch\n```\n\nTo publish a new package version, run `npm version [patch|minor|major]` and then `git push \u0026\u0026 git push --tags` on the master branch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichigan-tech-courses%2Frate-my-professors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichigan-tech-courses%2Frate-my-professors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichigan-tech-courses%2Frate-my-professors/lists"}