university-scraper

Python package for scraping university information


Keywords
python, uni, university, scraper, uni-scraper, university-scraper, uni-scrapers, university-scrapers
License
MIT
Install
pip install university-scraper==0.0.2

Documentation

Build Status Version License

A simple web scraping tool for recipe sites.

pip install uni-scrapers

then:

from uni_scrapers import available, load

# Get list of available universities
print(available())

# Give the abbreviation as a string, from the list of available universities
scraper = load('USYD)

scraper.courses()
scraper.units()

# Details can be retrieved for a certain course or unit using the respective kwargs
scraper.course_detail(...)
scraper.unit_detail(...)

# Can save to json or output to stdout
scraper.save_json(out_file=None)
scraper.stdout()

Scrapers available for:

Contribute

Part of the reason I want this open sourced is because if a university makes a design change, the scraper for it should be modified.

If you spot a design change (or something else) that makes the scraper unable to work for a given site - please fire an issue ASAP.

If you are a programmer, PRs with fixes are warmly welcomed and acknowledged with a virtual 🍺

If you want a scraper for a new university added

  • Open an Issue providing us the university name, as well as the direction on how to get the neccessary details

    • Unit details
    • Course/Program details
  • You are a developer and want to code the scraper on your own feel free to make a PR for us to review :)

For Devs / Contribute

Assuming you have python3 installed, navigate to the directory where you want this project to live in and drop these lines

    git clone https://github.com/Giuliano-C/UniScraper.git &&
    cd UniScaper &&
    pip install pipenv &&
    pipenv shell &&
    pipenv install &&
    python -m coverage run -m unittest

Acknowledgement

Project was built with reference to https://github.com/hhursev/recipe-scrapers