Skip to content

Commit 48d0506

Browse files
Niloth-ptimabbott
authored andcommitted
google-calendar: Update command usage help.
- Added a link to the integration doc. - Removed the initial space. - Fixed the command usage for the calendar option. - Added the integration-provided options to the first line. - Mentioned downloading the client secret file in the instructions. - Made other minor edits to the writing.
1 parent 101d79d commit 48d0506

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

zulip/integrations/google/google-calendar

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,20 @@ sent: Set[Tuple[int, datetime.datetime]] = set()
3636

3737
sys.path.append(os.path.dirname(__file__))
3838

39-
parser = zulip.add_default_arguments(
40-
argparse.ArgumentParser(
41-
r"""
39+
usage = r"""google-calendar --user EMAIL [--interval MINUTES] [--calendar CALENDAR_ID]
4240
43-
google-calendar --calendar [email protected]
41+
This integration can be used to send Zulip messages as reminders for upcoming events from your Google Calendar.
4442
45-
This integration can be used to send yourself reminders, on Zulip, of Google Calendar Events.
43+
Specify your Zulip API credentials and server in a ~/.zuliprc file, or using the options.
4644
47-
Specify your Zulip API credentials and server in a ~/.zuliprc file or using the options.
45+
Before running this integration, make sure you download the client secret file from Google, and run the get-google-credentials script to give Zulip read access to your Google Calendar.
4846
49-
Before running this integration make sure you run the get-google-credentials file to give Zulip
50-
access to certain aspects of your Google Account.
47+
This integration should be run on your local machine, as your API key is accessible to local users through the command line.
5148
52-
This integration should be run on your local machine. Your API key and other information are
53-
revealed to local users through the command line.
54-
55-
Depends on: google-api-python-client
49+
For more information, see https://zulip.com/integrations/doc/google-calendar.
5650
"""
57-
)
58-
)
51+
52+
parser = zulip.add_default_arguments(argparse.ArgumentParser(usage=usage))
5953

6054

6155
parser.add_argument(

0 commit comments

Comments
 (0)