Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

integrations: Update Google Calendar Docs. 

I have updated the docs for the Google Celndar integration to include
numbers to increase its readbility.

Fixes part of #17633.
This commit is contained in:
Adam Birds 2021-03-15 20:25:04 +00:00 committed by Tim Abbott
parent c14dd92c2c
commit eaf0212f6a
1 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
templates/zerver/integrations/google-calendar.md
View File

@ -1,69 +1,69 @@
Get Google Calendar reminders in Zulip! This is a great way to see
your reminders directly in your Zulip feed.
{!download-python-bindings.md!}
1. {!download-python-bindings.md!}
This bot should be set up on a trusted machine, because your API
key is visible to local users through the command line or config
file.
This bot should be set up on a trusted machine, because your API
key is visible to local users through the command line or config
file.
Next, follow the instructions for **Step 1** at
[this link](https://developers.google.com/google-apps/calendar/quickstart/python)
to get a `client_secret` file. Save this file as `client_secret.json`
to your `~/` directory.
1. Next, follow the instructions for **Step 1** at
[this link](https://developers.google.com/google-apps/calendar/quickstart/python)
to get a `client_secret` file. Save this file as `client_secret.json`
to your `~/` directory.
Next, install the latest Google API Client for Python by following the
instructions on the
[Google website](https://developers.google.com/api-client-library/python/start/installation).
1. Next, install the latest Google API Client for Python by following the
instructions on the
[Google website](https://developers.google.com/api-client-library/python/start/installation).
Then go to your **Zulip Settings** by clicking on the cog in the top
right corner, and then clicking on **Settings**.
1. Then go to your **Zulip Settings** by clicking on the cog in the top
right corner, and then clicking on **Settings**.
Click on the tab that’s labeled **Your bots** and click on
**Show/change your API key**. Enter your password if prompted, and
download the `zuliprc` file. Save this file as `.zuliprc` to your `~/`
directory.
1. Click on the tab that’s labeled **Your bots** and click on
**Show/change your API key**. Enter your password if prompted, and
download the `zuliprc` file. Save this file as `.zuliprc` to your `~/`
directory.
![Download zuliprc file](/static/images/integrations/google/calendar/001.png)
![Download zuliprc file](/static/images/integrations/google/calendar/001.png)
Run the `get-google-credentials` with this command:
1. Run the `get-google-credentials` with this command:
python /usr/local/share/zulip/integrations/google/get-google-credentials
python /usr/local/share/zulip/integrations/google/get-google-credentials
It should open up a browser and ask you for certain permissions. Give
Zulip access, and move on to the next step. If it doesn’t open a
browser, follow the instructions in the terminal window.
1. It should open up a browser and ask you for certain permissions. Give
Zulip access, and move on to the next step. If it doesn’t open a
browser, follow the instructions in the terminal window.
Now, all that’s left to do is to run the `gcal-bot` script, in the
same directory as the `get-google-credentials` script, with the
necessary parameters:
1. Now, all that’s left to do is to run the `gcal-bot` script, in the
same directory as the `get-google-credentials` script, with the
necessary parameters:
python /usr/local/share/zulip/integrations/google/gcal-bot --user foo@zulip.com
python /usr/local/share/zulip/integrations/google/gcal-bot --user foo@zulip.com
The `--user` flag specifies the user to send the reminder to.
The `--user` flag specifies the user to send the reminder to.
There are two optional flags that you can specify when running this
script:
1. There are two optional flags that you can specify when running this
script:
* `--calendar`: This flag specifies the calendar to watch from the
user’s Google account. By default, this flag is set to a user’s
primary or default calendar. To specify a calendar, you need the
calendar ID which can be obtained by going to Google Calendar and
clicking on the wedge next to the calendar’s name. Click on settings
in **Calendar settings** in the drop down, and look for the **Calendar
Address** section. Copy the **Calendar ID** from the right side of the
page and use that as the value for this flag.
* `--calendar`: This flag specifies the calendar to watch from the
user’s Google account. By default, this flag is set to a user’s
primary or default calendar. To specify a calendar, you need the
calendar ID which can be obtained by going to Google Calendar and
clicking on the wedge next to the calendar’s name. Click on settings
in **Calendar settings** in the drop down, and look for the **Calendar
Address** section. Copy the **Calendar ID** from the right side of the
page and use that as the value for this flag.
![Specify a calendar](/static/images/integrations/google/calendar/002.png)
![Specify a calendar](/static/images/integrations/google/calendar/002.png)
* `--interval`: This flag specifies the interval of time - in
minutes - between receiving the reminder, and the actual event. For
example, an interval of 30 minutes would mean that you would receive a
reminder for an event 30 minutes before it is scheduled to occur.
* `--interval`: This flag specifies the interval of time - in
minutes - between receiving the reminder, and the actual event. For
example, an interval of 30 minutes would mean that you would receive a
reminder for an event 30 minutes before it is scheduled to occur.
Don’t close the terminal window with the bot running (you can use
`screen` if needed). You will only get reminders if the bot is still
running.
1. Don’t close the terminal window with the bot running (you can use
`screen` if needed). You will only get reminders if the bot is still
running.
{!congrats.md!}