{"_id":"@chromeskullex/rate-my-professors","_rev":"1-8c3c17c05082fb4cf960315deb521846","name":"@chromeskullex/rate-my-professors","dist-tags":{"latest":"2.3.2"},"versions":{"2.3.0":{"name":"@chromeskullex/rate-my-professors","keywords":["🧑‍🏫","ratemyprofessors","professors","scrape","api","graphql","rate"],"version":"2.3.0","description":"a basic wrapper for Rate My Professors's GraphQL API with reviews","main":"dist/src/index.js","types":"dts/src/index.d.ts","repository":{"type":"git","url":"git+ssh://git@github.com/ChromeSkullex/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":"del -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","publish":"npm publish --access public"},"devDependencies":{"@types/node":"^14.14.19","@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":{"graphql":"^15.4.0","graphql-request":"^3.4.0"},"ava":{"files":["test/**/*"],"extensions":["ts"],"require":["ts-node/register"]},"gitHead":"9d5a14c5c5c717d9c20c0064e49f279cfdb7620a","bugs":{"url":"https://github.com/ChromeSkullex/rate-my-professors/issues"},"homepage":"https://github.com/ChromeSkullex/rate-my-professors#readme","_id":"@chromeskullex/rate-my-professors@2.3.0","_nodeVersion":"16.16.0","_npmVersion":"8.14.0","dist":{"integrity":"sha512-kOrSRPzYN1hoP9OwfG98Os8WrSBiXcdptMrrnrTiOye6ZPaOekcYCPhgxIDLyXOQUoIYv7Ab0aHHJmIxhxw89A==","shasum":"a7f15b8bebeeb3432a4d79be84d942590479690b","tarball":"https://registry.npmjs.org/@chromeskullex/rate-my-professors/-/rate-my-professors-2.3.0.tgz","fileCount":12,"unpackedSize":12387,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC8kWys2OPas7IqyHSRyodQ11XuNqfy4mZ8FMAQtlLsBwIgawZv9NNnXX9qwd66uUtZP456sLfi5h4Z9Le9QtrLb1U="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj5bq9ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr0Ng//W3M7djROc9bCJ9wDspJW4YqIlWJtreh0MXaBoLkGjML3L98f\r\n8X3V9e+3W7llgkt+u1QSskxMhnfJFBVE3tT6INuaFok/biyJwCR3whta+YZ6\r\n8V1ISOOVJAEynHUEvDEe60fsqe/HKi1joWE3XFYnNgF6D5Q5/mAEFGHHsizy\r\nwt0vox48Z+T9rcRKRzneHGJmi6h5ZEouDob0sKOiAZWzKEScJdwaXMxmSEAW\r\nsYyJnuUa37cjZxXEBdGu0/ATfk28g9LfaJ0sy9mTDdfcGjxTEQsgeRzjHMP/\r\np8b6VLVoG9aAcYIZfxjqaupQowyoh91WK4zc/VSkkcwcoxVe8cU1QLDtrZZH\r\ncShh7GENzJwFoVwS9GTI8YElYZLXXzf+69VKANNy3kxO6J238UgtYZtCUGXf\r\nL4C79q4kXMhYPnVaU79jeRKI2Az1uXJgKTJKU0HZsEQ2WVBLu0BhnBSMV7Om\r\nbyPtHXjZSFsK2MwLtBOvKOwXCoJnCtbf9OB55zMX9SpEXZuiYFAice8eBcFw\r\nRZ8n3bjFiIxYGNgaVbfW8OY8AqFZLEAnhLCL/X8iZ42RS8nNMjW+R4iHtUTM\r\nxSQXwv0ZQqeIOyUS7UCackJdUl5FywaJXbk1yApxItG4SdY5uoVZGKqN7/f/\r\nbHw4QzNwVXW5not0B95Pr5qRhkkwNTVnzts=\r\n=iYSt\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"chromeskullex","email":"szlgmoulton@gmail.com"},"directories":{},"maintainers":[{"name":"chromeskullex","email":"szlgmoulton@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rate-my-professors_2.3.0_1675999932855_0.9368264623556009"},"_hasShrinkwrap":false},"2.3.2":{"name":"@chromeskullex/rate-my-professors","keywords":["🧑‍🏫","ratemyprofessors","professors","scrape","api","graphql","rate"],"version":"2.3.2","description":"a basic wrapper for Rate My Professors's GraphQL API with reviews","main":"dist/src/index.js","types":"dts/src/index.d.ts","repository":{"type":"git","url":"git+ssh://git@github.com/ChromeSkullex/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":"del -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":"^14.14.19","@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":{"graphql":"^15.4.0","graphql-request":"^3.4.0"},"ava":{"files":["test/**/*"],"extensions":["ts"],"require":["ts-node/register"]},"gitHead":"9ff3981e1691323263575dce856408cbcf7be9ab","bugs":{"url":"https://github.com/ChromeSkullex/rate-my-professors/issues"},"homepage":"https://github.com/ChromeSkullex/rate-my-professors#readme","_id":"@chromeskullex/rate-my-professors@2.3.2","_nodeVersion":"16.16.0","_npmVersion":"8.14.0","dist":{"integrity":"sha512-PPgyS0W0JMApnJerrANHcqxrCerP2TziVoPsAjAI+Y7KSTCgLOm1IpiumTU12LNt4EHkep1FYNF18zZK11v82A==","shasum":"6fc42fa36ffaa21a1f724e8efd31946c2e56e419","tarball":"https://registry.npmjs.org/@chromeskullex/rate-my-professors/-/rate-my-professors-2.3.2.tgz","fileCount":12,"unpackedSize":12398,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFYYoLWLvb4s8HkVR0Ef5BK3kTLs/Ejv1uAeqSO1S04aAiEAl0zX2wypV47P5m8DHwgkpJfptcb/qKFcwNC6A/Ib5rQ="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj9VyeACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoBrw//S3sBOXfw18WqVpfw+MLH+6XGkn7oHJWnfEpCdul7mtmRPgpT\r\n4veCVpOHkuK0rRwuJYli0P+LKhefUu6Q2JGja8tik+i/Cj3VG2hyGDSZcIJ8\r\nlvceo1qnJr+R2pLcqGANozjiegD0RG0uAQHdgrxOONBROlFtg+JouexhrOBz\r\nGTxB1FrMLWQUU+DNToDYOV96x/uOce7Wv6OcECcy/Dyx2pDeudwVrifoR1HM\r\nxzWGvcPHENsW58jYeZsdzAloGO6nbyvwaEQzWw3TtkWoL9ucOKOetC1m6FYh\r\nNhLkzu1vZ7mHOgezX+ymYUyoClXX1KZ8zdLSTzldSkg6sGehL56BLPTK2+HD\r\nNcbWVwX9XDkWNGAkfxEe8rp8VbHVtI57pkpVHmu8/tR3v/AlaTUSQ0Y49Z2a\r\nBQRe+biVkhA6wHm7AR9OSYrRjej3RmMLZslkOZP36x2hTiipykJ7ckcoKyJN\r\nqAwuDg4IM7zNFlBz0kR9XpQ8yIanSWdKEalhEjLyAkbnWt1IIjUbgoUXCpzx\r\nAJfZdSWtPJQ2LuSfI6wqmG5Mh48eW48oV16k7ZUqKflFDPdXeFUebmELeD/W\r\nrZUpcylW7HnIKeIF4OMzmPY8Vy8V8Uc3EfUx+WfFjJGa27Pltuh/lntc9rR6\r\naSkfMOZrArqjePuH4HmACcPuUFBi10c//7M=\r\n=RsgQ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"chromeskullex","email":"szlgmoulton@gmail.com"},"directories":{},"maintainers":[{"name":"chromeskullex","email":"szlgmoulton@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rate-my-professors_2.3.2_1677024414042_0.6196850423839435"},"_hasShrinkwrap":false}},"time":{"created":"2023-02-10T03:32:12.778Z","2.3.0":"2023-02-10T03:32:13.012Z","modified":"2023-02-22T00:06:54.281Z","2.3.2":"2023-02-22T00:06:54.187Z"},"maintainers":[{"name":"chromeskullex","email":"szlgmoulton@gmail.com"}],"description":"a basic wrapper for Rate My Professors's GraphQL API with reviews","homepage":"https://github.com/ChromeSkullex/rate-my-professors#readme","keywords":["🧑‍🏫","ratemyprofessors","professors","scrape","api","graphql","rate"],"repository":{"type":"git","url":"git+ssh://git@github.com/ChromeSkullex/rate-my-professors.git"},"author":{"name":"Max Isom","email":"hi@maxisom.me"},"bugs":{"url":"https://github.com/ChromeSkullex/rate-my-professors/issues"},"license":"MIT","readme":"# 🧑‍🏫 @mtucourses/rate-my-professors\r\n\r\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)\r\n\r\nA basic wrapper for Rate My Professors's GraphQL API. Includes TypeScript definitions.\r\n\r\nIt is possible to pull full ratings with content as well, but currently this package just returns the average.\r\n\r\n## 🏗 Usage\r\n\r\n```js\r\n// Change to \r\n// const ratings = require('@mtucourses/rate-my-professors').default;\r\n// if using JS instead of TS\r\nimport ratings from '@mtucourses/rate-my-professors';\r\n\r\n(async () => {\r\n  const schools = await ratings.searchSchool('michigan technological university');\r\n\r\n  console.log(schools);\r\n  /*\r\n    [\r\n      {\r\n        city: 'Houghton',\r\n        id: 'U2Nob29sLTYwMg==',\r\n        name: 'Michigan Technological University',\r\n        state: 'MI'\r\n      }\r\n    ]\r\n  */\r\n\r\n  const teachers = await ratings.searchTeacher('mtu shene');\r\n\r\n  console.log(teachers);\r\n  /*\r\n    [\r\n      {\r\n        firstName: 'Ching-Kuang',\r\n        id: 'VGVhY2hlci0yMjkxNjI=',\r\n        lastName: 'Shene',\r\n        school: {\r\n          id: 'U2Nob29sLTYwMg==',\r\n          name: 'Michigan Technological University'\r\n        }\r\n      }\r\n    ] \r\n  */\r\n\r\n  const teacher = await ratings.getTeacher('VGVhY2hlci0yMjkxNjI=');\r\n\r\n  console.log(teacher);\r\n  /*\r\n    {\r\n      avgDifficulty: 4.4,\r\n      avgRating: 3.3,\r\n      numRatings: 28,\r\n      department: 'Computer Science',\r\n      firstName: 'Ching-Kuang',\r\n      id: 'VGVhY2hlci0yMjkxNjI=',\r\n      lastName: 'Shene',\r\n      school: {\r\n        city: 'Houghton',\r\n        id: 'U2Nob29sLTYwMg==',\r\n        name: 'Michigan Technological University',\r\n        state: 'MI'\r\n      },\r\n      legacyId: 1234567\r\n    }\r\n  */\r\n})();\r\n```\r\n\r\n## 🧰  Development\r\n\r\n```bash\r\n# First:\r\n# install dependencies\r\nyarn install\r\n\r\n# then:\r\n# build in watch mode\r\nyarn build:watch\r\n\r\n# and you can:\r\n\r\n# run tests\r\nyarn test\r\n\r\n# run tests in watch mode\r\nyarn test:watch\r\n```\r\n\r\nTo publish a new package version, run `npm version [patch|minor|major]` and then `git push && git push --tags` on the master branch.\r\n","readmeFilename":"README.md"}