You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Gabriel Augendre f8d56ec10c
Merge pull request #3 from Crocmagnon/dependabot/pip/flask-1.0
2 years ago
.gitignore Ignore all ide files 5 years ago
LICENSE Create LICENSE 5 years ago
Procfile Initial code 5 years ago
README.md Update README.md 3 years ago
app.py Allow multiple VTIMEZONE 5 years ago
requirements.txt Bump flask from 0.11.1 to 1.0 2 years ago
runtime.txt Update runtime.txt 3 years ago

README.md

Cal Proxy

Simple Flask app to proxy my school's calendar in order to filter courses I'm not following this year.

Usage

The app is configurable with environment variable and url parameters.

Environment variable URL parameter Type Meaning
BASE_URL None String Original calendar url
COURSES excluded_courses Comma separated values, without space The courses to exclude from the original calendar. Example : NRP,MGL,TIP
TYPES excluded_types Comma separated values, without space The course types to exclude from the original calendar. Example : Cours,TD
YEAR year String The year to fetch. Example : 4
GROUP group String The group to fetch. Example : 1
ALLOWED_YEARS None String Used to validate year specified in URL params. Example : 3,4,5
ALLOWED_GROUPS None String Used to validate group specified in URL params. Example : 1,2,3,4

Example

Default

After deploying the app and setting the environment variables you want, you can either call the root :

http://calendar.example.com/

You'll get the default calendar according to your environment.

URL params

You can also call the url with params :

http://calendar.example.com/?year=3&group=2&excluded_types=Cours&excluded_courses=PIT,SIS

The url params will override the defaults from your environment and you'll get the calendar for the 3rd year, 2nd group excluding all lectures and all PIT and SIS courses.