Skip to content

Commit a1e6903

Browse files
committed
docs: formatting and minor content revisions
1 parent bbedf9f commit a1e6903

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Download the executable suitable for your OS.
4545

4646
You can install Chrome for your OS by following the instructions [here](https://www.google.com/intl/en_uk/chrome/).
4747

48-
> <br>**weduc-timetable-extractor** will look for the Chrome browser instance in the default install location for the OS it is running on:
48+
> **weduc-timetable-extractor** will look for the Chrome browser instance in the default install location for the OS it is running on:
4949
>
5050
> | OS | Path |
5151
> | ------- | -------------------------------------------------------------- |
@@ -54,7 +54,6 @@ You can install Chrome for your OS by following the instructions [here](https://
5454
> | Ubuntu | `/usr/bin/google-chrome` |
5555
>
5656
> 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>
5857
5958
### Create `config.ini`
6059

@@ -105,10 +104,9 @@ Should either `username` or `password` be missing, the browser instance used to
105104

106105
if `chrome_path` is not specified then **weduc-timetable-extractor** will look for Chrome in the default install path.
107106

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`.
109108
>
110109
> An entry in the `.gitingore` file should prevent this but it bears repeating.
111-
> <br><br>
112110
113111
#### `ical`
114112

@@ -122,18 +120,17 @@ There should be one or more of these sections present. Each section name must be
122120

123121
| Entry | Purpose |
124122
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- |
125-
| `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._ |
126124
| `student_name` | The student's name, precisely as it appears in Weduc.<br> _Required._ |
127125
| `calendar_to_update` | The name of the Google Calendar to which Weduc timetable events will be pushed. <br> _Required_ if running in API mode. |
128126

129127
### Set up Google Calendar API
130128

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**.
132130
>
133131
> Setting up Google Calendar API is quite involved, so you may prefer to use **iCal mode** and import iCalendar files to Google Calendar manually.
134132
>
135133
> 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>
137134
138135
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.
139136

@@ -145,6 +142,20 @@ Having gone through this process, you should be prompted to download some client
145142

146143
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`.
147144

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+
148159
## Running **weduc-timetable-extractor**
149160

150161
Having carried out the setup steps above, you should have these files in the same folder:

0 commit comments

Comments
 (0)