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

bridge_between_zulips: Replace "subject" with "topic" in doc.

Browse source
This commit is contained in:
rht 2020-03-25 00:38:56 -04:00 committed by Tim Abbott
parent ceda54b50c
commit f47559e68d
2 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
zulip/integrations/bridge_between_zulips/README.md
View file

@ -3,18 +3,18 @@
Let `realm_1` be the first realm, `realm_2` be the second realm. Let `bot_1` be Let `realm_1` be the first realm, `realm_2` be the second realm. Let `bot_1` be
the relay bot in `realm_1`, `bot_2` be the relay bot in `realm_2`. the relay bot in `realm_1`, `bot_2` be the relay bot in `realm_2`.
This bot relays each message received at a specified subject in a specified This bot relays each message received at a specified topic in a specified
stream from `realm_1` to a specified subject in a specified stream in `realm_2`. stream from `realm_1` to a specified topic in a specified stream in `realm_2`.
Steps to create an inter-realm bridge: Steps to create an inter-realm bridge:
1. Register a generic bot (`bot_1`) in `realm_1` 1. Register a generic bot (`bot_1`) in `realm_1`
2. Enter the api info of `bot_1` into the config file (interrealm_bridge_config.py) 2. Enter the api info of `bot_1` into the config file (interrealm_bridge_config.py)
3. Create a stream in `realm_1` (`stream_1`) and a subject for the bridge 3. Create a stream in `realm_1` (`stream_1`) and a topic for the bridge
4. Make sure `bot_1` is subscribed to `stream_1` 4. Make sure `bot_1` is subscribed to `stream_1`
5. Enter the stream and the subject into the config file. 5. Enter the stream and the topic into the config file.
6. Do step 1-5 but for `bot_2` and with all occurrences of `_1` replaced with `_2` 6. Do step 1-5 but for `bot_2` and with all occurrences of `_1` replaced with `_2`
7. Run the script `run-interrealm-bridge` 7. Run the script `run-interrealm-bridge`
If the `--stream` flag is added (i.e. `run-interrealm-bridge --stream`), then If the `--stream` flag is added (i.e. `run-interrealm-bridge --stream`), then
the mirroring granularity becomes stream-wide. Instead of one subject, all the mirroring granularity becomes stream-wide. Instead of one topic, all
subjects within the stream are mirrored as-is without translation. topics within the stream are mirrored as-is without translation.

8
zulip/integrations/bridge_between_zulips/run-interrealm-bridge
View file

@ -60,12 +60,12 @@ def create_pipe_event(to_client: zulip.Client, from_bot: Dict[str, Any],
if __name__ == "__main__": if __name__ == "__main__":
usage = """run-interrealm-bridge [--stream] usage = """run-interrealm-bridge [--stream]
Relay each message received at a specified subject in a specified stream from Relay each message received at a specified topic in a specified stream from
the first realm to a specified subject in a specified stream in the second realm. the first realm to a specified topic in a specified stream in the second realm.
If the --stream flag is added, then the mirroring If the --stream flag is added, then the mirroring
granularity becomes stream-wide. Instead of one subject, granularity becomes stream-wide. Instead of one topic,
all subjects within the stream are mirrored as-is without all topics within the stream are mirrored as-is without
translation. translation.
""" """
sys.path.append(os.path.join(os.path.dirname(__file__), '..')) sys.path.append(os.path.join(os.path.dirname(__file__), '..'))