Skip to content

Exports Timetable for University of Nottingham Malaysia Student (mirror)

License

Notifications You must be signed in to change notification settings

ecyht2/nott-your-timetable

Repository files navigation

Nott Your Timetable

Exports Timetable for University of Nottingham Malaysia Student.

Table of Contents

Installation

Windows Folder (Recommended)

  1. Download the latest version of nott-your-timetable.zip here.
  2. Extract the .zip file.
  3. Run the .exe file inside the extracted folder.

Windows Single EXE

Note: Both folder and single exe file has the same features. However, the single exe file might take a longer time to start.

  1. Download the latest version of nott-your-timetable.exe here.
  2. Run the .exe file.

MacOS

Note: Both versions have the same features, but the first one might take a longer time to start.

  1. Download the latest version of nott-your-timetable-macos.zip or nott-your-timetable-macos-folder.zip (recommended) here.
  2. Extract the .zip file.
  3. Move the extracted .app file into Applications folder (optional).
  4. Run the .app file.

Installing via Pip

Requirements

python>=3.10 Latest version of Python can be downloaded here for more information

Installation

pip install nott-your-timetable

For GUI support:

Note: there might be some error isntalling PyGObject using pip, follow the instruction here to download gtk. When following the instructions replace all refrences to gtk3 with gtk4 as nott-your-timetable uses gtk4 and not gtk3 e.g. mingw-w64-x86_64-gtk3 -> mingw-w64-x86_64-gtk4.

pip install nott-your-timetable[gui]

Usage

GUI

  1. Select School/Division School/Division Selection
  2. Select Program Program Selection
  3. Select week period Weeks Selection
  4. Select day period Days Selection
  5. Select export file format and hit continue. If you are confused just choose ics. Export Format Selection
  6. Select location to save. Save Location Selection

Importing Timetable

Outlook

  1. Open Outlook and go to the calendar section. Outlook Calendar
  2. Click on add calendar. Adding Calendar
  3. Click on upload from file. Upload from file
  4. Select file and calendar to import to. Uploading Calendar
  5. Done :) Imported Calendar

Google Calendar

TODO

CLI

A simple usage to export the entire year to a ics file by default.

Note: The quotes are needed if you are putting spaces inbetween

Gets the timetable for Electrical and Electronic Engineering BEng Year 2:

nott-your-timetable-cli -c "E & EE" "BEng Hons Electl & Electnc Eng/F/02 - H603 Electrical and Electronic Engineering"

Only for week 1 to week 10.

nott-your-timetable-cli -w '1-10' -c "E & EE" "BEng Hons Electl & Electnc Eng/F/02 - H603 Electrical and Electronic Engineering"

Only for Monday to Friday.

nott-your-timetable-cli -c "E & EE" "BEng Hons Electl & Electnc Eng/F/02 - H603 Electrical and Electronic Engineering" -d 1-5

Only for week 4 to week 6 Monday to Friday.

nott-your-timetable-cli -c "E & EE" "BEng Hons Electl & Electnc Eng/F/02 - H603 Electrical and Electronic Engineering" -d '4, 5, 6' -w 1-5

If you don't know what school/division and program, the -i flag can be used to ender interactive mode.

nott-your-timetable-cli -i

To export the output to csv

nott-your-timetable-cli -c "E & EE" "BEng Hons Electl & Electnc Eng/F/02 - H603 Electrical and Electronic Engineering" -f csv

There are more options available, to see all the options use the help argument.

nott-your-timetable-cli -h

TODO

  • Support for exporting to other formats
    • CSV
    • iCalander
    • vCard
  • Support for other course programs
  • Add more convinience option e.g. Schedule for Spring Semester
  • A graphical frontend
  • Add GUI and TUI for displaying timetable
  • Make use of Calender Object
  • Add Export Options
  • Add better help descriptions
  • Support for mutiple program selection
  • Add binaries
    • EXE (Windows)
      • EXE
      • Installer
    • Application (MacOS)
      • App Bundle
      • DMG
    • Appimage (Linux)
    • PKGBUILD (AUR/Arch)
    • DEB (Debian)
    • RPM (Red Hat)
    • Flatpak (Linux) (Maybe?)
    • Snaps (Linux) (Maybe?)