Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 3.16 KB

README.md

File metadata and controls

59 lines (42 loc) · 3.16 KB
Raw

StudentsCalendar

Students Calendar is dedicated to all students of Mannheim University, who want to use their personal lecture timetable on their favorite mobile device or calendar app (Apple iCal, Mozilla Thunderbird, Microsift Outlook...).

It is a small ruby program to convert the personal timetable you maintained in the students portal to an iCalendar (.ics) file. This file can be imported as an additional calendar on most mobile devices or calendar apps.

Please note: StudentsCalendar is rather new and I encourage you to double check imported dates and times. Don't blame me if you miss your lectures :-)

##Prerequisites As StudentsCalendar is written in ruby you need a working ruby 1.9.X environment (check whether 'ruby --version' returns something like 'ruby 1.9....'). Additionally the following gems should be installed:

  • ri_cal
  • tzinfo
  • activesupport
  • nokogiri
  • mechanize
  • highline/import

use gem install <gem_name> to install.

##How to use

  1. Download 'students_calendar.rb'
  2. Open you favorite terminal and execute ruby students_calendar.rb <path_to_new_ics_file> e.g. ruby students_calendar.rb /Users/example/Desktop/timetable.ics
  3. Enter your University of Mannheim portal user credentials
  4. Import the created file wherever you like

##Limitations

  • File mode: The conversion works for timetable.html downloaded in German language only
  • File mode: The conversion works for view options "plan: long" and "Teaching Period" only

##Future Features What I currently uploaded is a first version which which fulfills my aspiration to laziness, which means not to add each course to my calendar manually over and over again every semester. I have several ideas for addiational features that might be useful. Unfortunately time is limited and thefore I hope that others join the development. Additional features might be:

  • Convert the script into a web application (e.g. Rails), where users just have to input the URL
  • Add additional events to the calendar e.g. exams, semester dates....

##Bugs Please use the 'Issues' functionality on github to report any kind of bugs

LICENSE:

The MIT License (MIT) Copyright (c) 2012 Norman Weisenburger

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.