xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

api: Document options required for use with Zulip Enterprise.

Browse source 
(imported from commit 59f136cf0f1a5d9509bec054b060ab44695b77e0)
This commit is contained in:
Tim Abbott 2013-12-04 15:17:18 -05:00
parent c9b0e190d0
commit d38929d525
2 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -31,9 +31,14 @@ file is as follows:
key=<api key from the web interface> key=<api key from the web interface>
email=<your email address> email=<your email address>
If you are using Zulip Enterprise, you should also add
site=<your Zulip Enterprise server's URI>
Alternatively, you may explicitly use "--user" and "--api-key" in our Alternatively, you may explicitly use "--user" and "--api-key" in our
examples, which is especially useful if you are running several bots 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 You can obtain your Zulip API key, create bots, and manage bots all
from your Zulip [settings page](https://zulip.com/#settings). from your Zulip [settings page](https://zulip.com/#settings).

4
zulip/__init__.py
View file

@ -47,8 +47,8 @@ API_VERSTRING = "v1/"
def generate_option_group(parser): def generate_option_group(parser):
group = optparse.OptionGroup(parser, 'API configuration') group = optparse.OptionGroup(parser, 'API configuration')
group.add_option('--site', group.add_option('--site',
default=None, help="Zulip Enterprise server URI (if using Zulip Enterprise)",
help=optparse.SUPPRESS_HELP) default=None)
group.add_option('--api-key', group.add_option('--api-key',
action='store') action='store')
group.add_option('--user', group.add_option('--user',