novaunl / clipy Goto Github PK

In case you have no clue of what CLIP is then this package is not for you.

This is a crawler which downloads relevant information from CLIP, as such it requires student credentials. It does provide an interface (both programatic as wel as a webservice with REST endpoints) to lookup the crawled data.

Even if you're a student and have the all mighty credentials, it still isn't probably something you'll want to try.

If you're brave and want to try it, or want that information for something else (please don't be evil), it takes several days to fully bootstrap the database, and it's a somewhat error-prone process with a lot of disconnections along the way.

Avoid doing so during times that might disturb other students access to CLIP. This thing does several requests every second. 1AM-6AM(GMT) it's probably your best shot.

pip install clip-crawler

Setup an environment variable pointing to a settings file:

CONFIG=conf/flask/settings-example.json

Make sure to insert proper credentials in that settings file.

from CLIPy import Clip

Clip.bootstrap_database('CLIP ID', 'password', storage)

clip = Clip()
# Don't run it like this, it takes forever. Look at the parameters
clip.bootstrap_database()
[print(student) for student in clip.find_student("John Smith")]

Right now, most of CLIP data.

• Students
• Teachers
• Classes (most of their information, student grades, turns, teachers)
• Departments
• Courses
• Files (with deduplication :) )
• Physical entities (buildings, classrooms, auditoriums, laboratories, ...)
• National access contest admissions
• Library occupied/spare rooms

• Timespan filters (eg: crawl [thing] from 2015 to 2017)
• Evaluation dates
• Class summaries
• Course curricular plans (possibly impossible as CLIP does not expose CP rules)
• Better student course tagging