{"_id":"@domattheshack/rate-my-professors","name":"@domattheshack/rate-my-professors","dist-tags":{"latest":"2.2.1"},"versions":{"2.2.1":{"name":"@domattheshack/rate-my-professors","keywords":["🧑‍🏫","ratemyprofessors","professors","scrape","api","graphql","rate"],"version":"2.2.1","description":"a basic wrapper for Rate My Professors's GraphQL API. This package has been forked from https://github.com/maxisom/rate-my-professors. Then updated but DomAtTheShack","main":"dist/src/index.js","types":"dts/src/index.d.ts","repository":{"type":"git","url":"git+ssh://git@github.com/Michigan-Tech-Courses/rate-my-professors.git"},"author":{"name":"Max Isom","email":"hi@maxisom.me"},"license":"MIT","scripts":{"lint":"eslint 'src/**/*.ts'","lint:fix":"eslint 'src/**/*.ts' --fix","clean":"rm -rf dist dts","build":"tsc","build:watch":"tsc --watch","test":"ava","test:watch":"ava --watch","test:coverage":"nyc --reporter=lcov ava","prepack":"yarn clean && yarn build","start":"node dist/index.js"},"devDependencies":{"@types/node":"^18.0.0","@typescript-eslint/eslint-plugin":"^4.11.1","@typescript-eslint/parser":"^4.11.1","ava":"^3.15.0","eslint":"^7.17.0","eslint-config-xo":"^0.33.1","eslint-config-xo-typescript":"^0.37.0","husky":"^4.3.6","lint-staged":"^10.5.3","nyc":"^15.1.0","ts-node":"^9.1.1","typescript":"^4.1.3"},"eslintConfig":{"extends":["xo","xo-typescript/space"],"parser":"@typescript-eslint/parser","parserOptions":{"project":"./tsconfig.json"},"rules":{"new-cap":"off","@typescript-eslint/no-unused-vars":"off","@typescript-eslint/no-unused-vars-experimental":"error","@typescript-eslint/prefer-readonly-parameter-types":"off"}},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,ts,tsx}":["eslint 'src/**/*.ts' --fix"]},"dependencies":{"@types/isomorphic-fetch":"^0.0.36","graphql":"^15.4.0","graphql-request":"^3.4.0","isomorphic-fetch":"^3.0.0","yarn":"^1.22.22"},"ava":{"files":["test/**/*"],"extensions":["ts"],"require":["ts-node/register"]},"_id":"@domattheshack/rate-my-professors@2.2.1","gitHead":"ea8359a2fd6fadb471a026361b13faa98aff4524","bugs":{"url":"https://github.com/Michigan-Tech-Courses/rate-my-professors/issues"},"homepage":"https://github.com/Michigan-Tech-Courses/rate-my-professors#readme","_nodeVersion":"20.19.5","_npmVersion":"10.8.2","dist":{"integrity":"sha512-BcX/fD4269pbQmZGsXFakSI0s6N5ghfPQlO6aG31fyND1wSI8JJcLcfntwOAubJzQuW/n68iIFW1MpJ2/cVW+w==","shasum":"5784a8ef3af52766b84d111f444026a6657780c9","tarball":"https://registry.npmjs.org/@domattheshack/rate-my-professors/-/rate-my-professors-2.2.1.tgz","fileCount":12,"unpackedSize":15227,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDeIR4jYEkRjok10Llpu+Ah+6W1jd70HQmDnRusMrjvBAIhAOMsonKjfNmd/2rjM7mt1xA9raga4MXwCTc42jJjlkig"}]},"_npmUser":{"name":"domattheshack","email":"dominic@domsmacshack.com"},"directories":{},"maintainers":[{"name":"domattheshack","email":"dominic@domsmacshack.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/rate-my-professors_2.2.1_1761744688096_0.11483762486251736"},"_hasShrinkwrap":false}},"time":{"created":"2025-10-29T13:31:27.891Z","2.2.1":"2025-10-29T13:31:28.456Z","modified":"2025-10-29T13:31:28.852Z"},"maintainers":[{"name":"domattheshack","email":"dominic@domsmacshack.com"}],"description":"a basic wrapper for Rate My Professors's GraphQL API. This package has been forked from https://github.com/maxisom/rate-my-professors. Then updated but DomAtTheShack","homepage":"https://github.com/Michigan-Tech-Courses/rate-my-professors#readme","keywords":["🧑‍🏫","ratemyprofessors","professors","scrape","api","graphql","rate"],"repository":{"type":"git","url":"git+ssh://git@github.com/Michigan-Tech-Courses/rate-my-professors.git"},"author":{"name":"Max Isom","email":"hi@maxisom.me"},"bugs":{"url":"https://github.com/Michigan-Tech-Courses/rate-my-professors/issues"},"license":"MIT","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 () => {\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 && git push --tags` on the master branch.\n","readmeFilename":"README.md","_rev":"1-830720fb9b80c97679c7d5a4ba32c194"}