Data

Tools

Indexes

Applications

Experiments

Open Source Science

sutd-calendar-fixer

SUTD Class Schedule .ics Fixer

https://github.com/markhershey/sutd-calendar-fixer

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary

Keywords

calendar google-calendar schedule
Last synced: 6 months ago · JSON representation ·

Repository

SUTD Class Schedule .ics Fixer

Basic Info
  • Host: GitHub
  • Owner: MarkHershey
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 419 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 2
  • Open Issues: 0
  • Releases: 0
Topics
calendar google-calendar schedule
Created about 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

SUTD schedule.ics Fixer

[!IMPORTANT] The website mymobile.sutd.edu.sg has been removed by SUTD (since 15 Dec 2024).

The telegram bot @sutdicsbot has been retired following the removal of the website after serving at least 1838 unique users.

Do you know that you can import your class schedule into your Google Calendar?

You can download a schedule.ics file from mymobile.sutd.edu.sg, but the original file is badly formatted and it won't look good on your calendar App.

This bot helps you clean up the mess in the schedule.ics file so that you will get a neat calendar view.

| Before | After | | :------------------------------------------------: | :-----------------------------------------------: | | | |

Usage

Manual:

  1. clone this repository to your local machine bash git clone https://github.com/MarkHershey/sutd-calendar-fixer.git
  2. install dependencies: bash cd sutd-calendar-fixer python3 -m pip install -r requirements.txt
  3. run the following command: bash python3 src/calendarFixer.py "path/to/your/schedule.ics"

Dependencies

Run Tests

bash pytest

  • This will run all the test ics files in the tests/resources/ics_inputs directory. You may add more test files to it.
  • The expected output is in the tests/resources/ics_outputs directory.
  • Please manually check the diffs to the output files if you modified the src/calendarFixer code. Make sure all changes are intended.
  • Make sure you run the tests and commit all the changes (i.e. including the tests/resources/ics_outputs) before creating a pull request.

Run in Docker

  1. Modify docker-compose.yml file, substitute your own Telegram BOT_TOKEN.
  2. To launch bot, run docker compose up --build -d
  3. To terminate bot, run docker compose down --rmi all

Check logs

bash cat "logs/debug.txt" cat "logs/error.txt"

License

This project is licensed under the MIT LICENSE.

Owner

  • Name: Mark Huang
  • Login: MarkHershey
  • Kind: user
  • Location: Singapore

ML Research | PhD Student at SUTD

Citation (CITATION.cff) 

# YAML 1.2
---
cff-version: 1.2.0
message: "If you use this repository, please cite it as below."
authors:
    - affiliation: "Singapore University of Technology and Design"
      family-names: "Huang"
      given-names: "Mark He"
title: "SUTD Class Schedule ICS Fixer"
version: 1.0.0
date-released: 2020-01-31
url: "https://github.com/MarkHershey/sutd-calendar-fixer"

GitHub Events

Total
  • Watch event: 1
  • Push event: 1
Last Year
  • Watch event: 1
  • Push event: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 1
  • Total pull requests: 2
  • Average time to close issues: about 14 hours
  • Average time to close pull requests: about 23 hours
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 5.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • ClementLohCK (1)
Pull Request Authors
  • YongJunLim (2)
  • chestnutcase (1)
Top Labels
Issue Labels
Pull Request Labels
enhancement (1) good first issue (1)

Dependencies

Dockerfile docker
  • python 3 build
docker-compose.yml docker
requirements.txt pypi
  • puts ==0.0.8
  • python-telegram-bot ==13.11