Skip to content

anishgowda21/RIT-sis-scraper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RIT SIS scraper

An api built using fastapi to get student info from RIT website

made-with-python Hits Open Source Love svg1

Run Locally

Clone the project

  git clone https://github.com/anishgowda21/RIT-sis-scraper

Go to the project directory

  cd RIT-sis-scraper

Install dependencies

  pip3 install -r requirements.txt

Start the server

  uvicorn main:app --reload
  • Go to http://127.0.0.1:8000/doc (The port number may be diffrent check it in your terminal)

Deployment

If you wish to deploy this project in heroku just click the button below

Deploy

API Reference

Get sis data

  GET /sis/?usn={usn}&dob={dob}

Note if you are a first year please add parameter firstyear=true

  GET /sis/?usn={usn}&dob={dob}&firstyear=true
Parameter Type Description
usn string Required. your usn
dob string Required. your dob in yyyy-mm-dd form
firstyear bool optional. If you are a first year add this

Example api call from local machine

http://127.0.0.1:8000/sis/?usn=1ms19cd540&dob=2001-07-21

For a first year student

http://127.0.0.1:8000/sis/?usn=1ms19cd540&dob=2001-07-21&firstyear=true

Or you can see a demo at https://ritsis.herokuapp.com/

Example call

https://ritsis.herokuapp.com/sis/?usn=1ms19cd540&dob=2001-07-21&firstyear=true

As mentioned before the firstyear parameter is optional and only applicable for first year students

Contributing

Any suggestions for this project is welcome

  • Just fork the repo make your changes and send a PR

If you like this project show some ❤️ and give this repo a ⭐

Thank You

About

A api built using fastapi to scrape student info from RIT website

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published