Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mk2112/hwr-berlin-calendar-sync
Sync your lecture plan at the Berlin School of Economics and Law with Google Calendar.
https://github.com/mk2112/hwr-berlin-calendar-sync
google-api-python-client google-calendar python
Last synced: about 1 month ago
JSON representation
Sync your lecture plan at the Berlin School of Economics and Law with Google Calendar.
- Host: GitHub
- URL: https://github.com/mk2112/hwr-berlin-calendar-sync
- Owner: MK2112
- License: mit
- Created: 2023-10-13T11:30:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-21T08:56:01.000Z (8 months ago)
- Last Synced: 2024-05-21T10:35:03.795Z (8 months ago)
- Topics: google-api-python-client, google-calendar, python
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HWR Berlin - Google Calendar Lecture Sync
Sync lectures of the Berlin School of Economics and Law (HWR Berlin) with your Google Calendar.
This script identifies new or changed calendar entries, updates your Google Calendar, and marks outdated events as such (without deleting them, just to be safe).
## Setup
1. Download/Clone this repository and navigate to it
2. [Download](https://www.python.org/downloads/) and install Python 3.11 or higher
3. Open a terminal in the repository's root folder, install required Python packages like so:
`pip install -r requirements.txt`
4. Log into your Google account and create a new,
empty Google Calendar; **Remember the calendar title**
5. Make your new calendar visible on your phone using the [Google Calendar Sync Settings](https://calendar.google.com/calendar/u/0/syncselect)
6. Google API Setup:
- Head to the [Google API Console](https://console.developers.google.com/apis/dashboard), create a new project
- Enable the `Google Calendar API`
- Generate a new OAuth 2.0 Client ID
- Download the json file with your credentials, rename it to `credentials.json` and move it to the project's root folder, next to `hwr.py`
7. Configure `hwr.py`:
- Open `hwr.py` in a text editor and modify the 'Settings' section:
- `hwr_ics_link` - Set the URL to link to the ICS file for your lecture plan
- Go to the HWR Berlin's Lecture Plan
- Select your course and semester, then right-click copy the link `Stundenplan herunterladen (ICS)`
- Replace the existing link in the `hwr.py` script with the copied link
- `google_calendar_name` - Set this to the previously noted title of your Google Calendar
- `update_depth` - (Optional) Set the number of events to update into the future (default: 50)
**Note:** The initial run will prompt you to grant your API project access to your Google Calendar.
This is a one-time process fully controlled by Google. Google may inform you that the API project is not verified, which is true and normal.
The script at no point shares your credentials with anybody but Google.
Refer to the [Google Calendar API documentation](https://developers.google.com/calendar/api/quickstart/python) for more setup details.
## Usage
For a full sync, writing everything there is to the calendar, execute:
```py
python hwr.py
```
Do this **once, for an initial run**, to populate your calendar with all events.
From there on out, update for a specific number of future events (minimizing API usage and server load) like so:
```py
python hwr.py --update
```
**Note:** The script runs indefinitely, automatically updating the calendar at given intervals.
## License
This project is released under the MIT License. See the [LICENSE](LICENSE) file for details.
### Contributions
Contributions and feedback are welcome. Feel free to open issues or pull requests.
### Disclaimer
This script is provided as-is, without any warranties or guarantees.
Users are responsible for ensuring compliance with applicable laws and regulations.