https://github.com/ryanmalonzo/myges-ics-stream

Serving my class schedule over HTTP as iCalendar for easy importing.
https://github.com/ryanmalonzo/myges-ics-stream

api esgi flask icalendar ics myges

Last synced: 4 days ago
JSON representation

Serving my class schedule over HTTP as iCalendar for easy importing.

• Host: GitHub
• URL: https://github.com/ryanmalonzo/myges-ics-stream
• Owner: ryanmalonzo
• Created: 2024-09-11T15:59:15.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-04T22:05:52.000Z (18 days ago)
• Last Synced: 2024-12-04T23:19:08.892Z (18 days ago)
• Topics: api, esgi, flask, icalendar, ics, myges
• Language: Python
• Homepage: https://hub.docker.com/repository/docker/ryanmalonzo/myges-ics-stream
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# myges-ics-stream

Serving my class schedule over HTTP as iCalendar for easy importing.

## Why?

It often takes several minutes to load one's timetable from my school's offical website.  

This small Python program provides an HTTP endpoint that will serve the provided user's schedule in iCalendar format, and that can be subscribed to using one's favorite calendar app.



## How to run

Clone the repository, set the required environment variables in `.env`, then run

```sh

docker compose up -d

```

Alternatively, use the Docker image available on [Docker Hub](https://hub.docker.com/r/ryanmalonzo/myges-ics-stream), like so:

```yml

services:

  myges-ics-stream:

    image: ryanmalonzo/myges-ics-stream:latest

    container_name: myges

    environment:

      MYGES_USERNAME: ${MYGES_USERNAME}

      MYGES_PASSWORD: ${MYGES_PASSWORD}

    restart: unless-stopped

```

## Usage

By default, the calendar will be available on port `8080`, at `/calendar`.  

If running locally, an example URL would be `http://localhost:8080/calendar` or `http://:8080/calendar`.  

## Environment variables

| Environment variable   | Description                                                                                                                                  | Example value | Required? |

| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------- |

| MYGES_USERNAME         | Your MyGES username.                                                                                                                         | rmalonzo      | True      |

| MYGES_PASSWORD         | Your MyGES password.                                                                                                                         | mypassword123 | True      |

| FETCH_INTERVAL_MINUTES | The time until each refresh of the calendar. Defaults to `60` minutes.                                                                       | 120           | False     |

| TIMEZONE               | The TZ identifier for the calendar as described [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `Etc/UTC`. | Asia/Tokyo    | False     |

> [!IMPORTANT]  

> In most cases, `Etc/UTC` should be the right value regardless of where you actually live. Instead, you should set the correct timezone in your calendar app settings.

## Troubleshooting

### Google Calendar

The subscription URL will not work if the DNS record is proxied through Cloudflare.  

To avoid this, Bot Fight Mode needs to be turned off in Security > Bots.

## Acknowledgements

- [UnBonWhisky/myges-to-icalendar](https://github.com/UnBonWhisky/myges-to-icalendar) for the API endpoints.