You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -54,7 +54,6 @@ You can install Chrome for your OS by following the instructions [here](https://
54
54
> | Ubuntu |`/usr/bin/google-chrome`|
55
55
>
56
56
> If you wish to use a Chrome executable installed to a non-default location, you can specify the path in the `config.ini` file (see below for more info).
57
-
> <br><br>
58
57
59
58
### Create `config.ini`
60
59
@@ -105,10 +104,9 @@ Should either `username` or `password` be missing, the browser instance used to
105
104
106
105
if `chrome_path` is not specified then **weduc-timetable-extractor** will look for Chrome in the default install path.
107
106
108
-
> <br>If you have forked this Repo for your own development, **_be wary of accidentally committing a `password`_** that might be present in `config.ini`.
107
+
> If you have forked this Repo for your own development, **_be wary of accidentally committing a `password`_** that might be present in `config.ini`.
109
108
>
110
109
> An entry in the `.gitingore` file should prevent this but it bears repeating.
111
-
> <br><br>
112
110
113
111
#### `ical`
114
112
@@ -122,18 +120,17 @@ There should be one or more of these sections present. Each section name must be
|`school_name`| The name of the School that the student goes to, precisely as it appears in Weduc.<br> _Required._|
123
+
|`school_name`| The name of the school that the student goes to, precisely as it appears in Weduc.<br> _Required._|
126
124
|`student_name`| The student's name, precisely as it appears in Weduc.<br> _Required._|
127
125
|`calendar_to_update`| The name of the Google Calendar to which Weduc timetable events will be pushed. <br> _Required_ if running in API mode. |
128
126
129
127
### Set up Google Calendar API
130
128
131
-
> <br>This is only necessary if you plan to use **API mode**.
129
+
> This is only necessary if you plan to use **API mode**.
132
130
>
133
131
> Setting up Google Calendar API is quite involved, so you may prefer to use **iCal mode** and import iCalendar files to Google Calendar manually.
134
132
>
135
133
> You would also want to use **iCal mode** if you plan to import Weduc timetable events into calendars other than Google Calendar.
136
-
> <br><br>
137
134
138
135
To set up Google Calendar API, complete the three tasks described [here](https://developers.google.com/calendar/api/quickstart/python#set-up-environment). You only need to complete the tasks in the _'Set up your environment'_ section.
139
136
@@ -145,6 +142,20 @@ Having gone through this process, you should be prompted to download some client
145
142
146
143
Make sure the file you have downloaded is renamed as such, and is placed in the same folder as the downloaded `weduc-timetable-extractor` executable, alongside `config.ini`.
147
144
145
+
> ### A note on auth. token expiry
146
+
>
147
+
> Unless you are prepared to go through an arduous verification process, you will have to leave the project created for Calendar API access in **test mode**. Unfortunately, this means the token issued when authenticating with Google has a short expiry, of seven days.
148
+
>
149
+
> This is fine if you are running **weduc-timetable-extractor** manually, as you can re-authenticate when prompted.
150
+
>
151
+
> It will, however, be a barrier if you want to automate timetable extraction.
152
+
>
153
+
> #### A workaround (for some)
154
+
>
155
+
> If you have a [Google Workspace](https://workspace.google.com/intl/en_uk/) set up, then you can create Calendar API projects that do not have to be in test mode.
156
+
>
157
+
> Thus, you can push events to a user's calendar within your organization and then share the calendar externally with any other Google Calendar user.
158
+
148
159
## Running **weduc-timetable-extractor**
149
160
150
161
Having carried out the setup steps above, you should have these files in the same folder:
0 commit comments