From d38929d525b52433778a414c1c46273e872fdcbb Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Wed, 4 Dec 2013 15:17:18 -0500 Subject: [PATCH] api: Document options required for use with Zulip Enterprise. (imported from commit 59f136cf0f1a5d9509bec054b060ab44695b77e0) --- README.md | 7 ++++++- zulip/__init__.py | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index be6ebe4..8e5d625 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,14 @@ file is as follows: key= email= +If you are using Zulip Enterprise, you should also add + + site= + Alternatively, you may explicitly use "--user" and "--api-key" in our examples, which is especially useful if you are running several bots -which share a home directory. +which share a home directory. There is also a "--site" option for +setting the Zulip Enterprise server on the command line. You can obtain your Zulip API key, create bots, and manage bots all from your Zulip [settings page](https://zulip.com/#settings). diff --git a/zulip/__init__.py b/zulip/__init__.py index d7cbb35..c5fcfc7 100644 --- a/zulip/__init__.py +++ b/zulip/__init__.py @@ -47,8 +47,8 @@ API_VERSTRING = "v1/" def generate_option_group(parser): group = optparse.OptionGroup(parser, 'API configuration') group.add_option('--site', - default=None, - help=optparse.SUPPRESS_HELP) + help="Zulip Enterprise server URI (if using Zulip Enterprise)", + default=None) group.add_option('--api-key', action='store') group.add_option('--user',