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

matrix bridge: Add description of script & some useful tips.

Browse source
This commit is contained in:
neiljp (Neil Pilgrim) 2018-06-01 18:05:54 -07:00
parent 70ba4c9035
commit 78c64d069b
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
zulip/integrations/matrix/matrix_bridge.py
View file

@ -157,7 +157,19 @@ def check_zulip_message_validity(msg: Dict[str, Any], config: Dict[str, Any]) ->
def parse_args(): def parse_args():
# type: () -> Any # type: () -> Any
parser = argparse.ArgumentParser() description = """
Script to bridge between a topic in a Zulip stream, and a Matrix channel.
Tested connections:
* Zulip <-> Matrix channel
* Zulip <-> IRC channel (bridged via Matrix)
Example matrix 'room_id' options might be, if via matrix.org:
* #zulip:matrix.org (zulip channel on Matrix)
* #freenode_#zulip:matrix.org (zulip channel on irc.freenode.net)"""
parser = argparse.ArgumentParser(description=description,
formatter_class=argparse.RawTextHelpFormatter)
parser.add_argument('-c', '--config', required=True, parser.add_argument('-c', '--config', required=True,
help="Path to the config file for the bridge.") help="Path to the config file for the bridge.")
parser.add_argument('--show-join-leave', dest='no_noise', parser.add_argument('--show-join-leave', dest='no_noise',