-
Clone or fork into your local repository
-
Install pipenv if you don't already have it
pip install pipenv-
Add your course list in the data folder. Note: you must use the exact column headers and name the file src-data.xlsx
-
Create virtual python environment and install dependencies
pipenv shell && pipenv install -
Setup Google OAuth Credentials and add the credentials.json file into the project root. Make sure to set the uri to http://localhost:5000/
-
To run the application from the root directory
cd calendar && python quickstart.py- When you first run the application approval needs to be given to the app
- Have fun
- Solve a real-world problem using Python
- Gain practical experience in using collaborative tools such as GitHub and Trello
- Create a schedule that serves as a guide for when to study and when to take breaks
- The app takes in a course list (excel or csv) with duration of each topic (in this case a video course), as shown in Table 1, and outputs a study schedule based on parameters inputted by the user (e.g. study duration/day, break duration etc).
- Outputted study schedule then gets automatically put into your Google Calendar via an API call
- Excel schedule outputed based on a pomodoro split of 45 minutes of study and 15 minutes break
- Calendar events that were inserted based on above study schedule
- Current ongoing and future developments of this project can be seen detailed in the milestones tab
Pipenv Guide - Virtual Environment & Package Management
Google Calendar - Python Installation