History

Anders Kaseorg 2f6623bbc4 cleanup: Remove unused imports. Generated by autoflake. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>		2020-04-18 20:31:14 -07:00
..
irc-mirror.py	cleanup: Remove unused imports.	2020-04-18 20:31:14 -07:00
irc_mirror_backend.py	cleanup: Remove unused imports.	2020-04-18 20:31:14 -07:00
README.md	bridge_with_irc: Tell people to subscribe their bots to the stream.	2019-01-23 12:40:47 -08:00
requirements.txt	bridge_with_irc: Bump irc requirements version.	2019-01-16 16:27:52 -08:00

README.md

IRC <--> Zulip bridge

Usage

./irc-mirror.py --irc-server=IRC_SERVER --channel=<CHANNEL> --nick-prefix=<NICK> --stream=<STREAM> [optional args]

--stream is a Zulip stream. --topic is a Zulip topic, is optionally specified, defaults to "IRC".

IMPORTANT: Make sure the bot is subscribed to the relevant Zulip stream!!

Specify your Zulip API credentials and server in a ~/.zuliprc file or using the options.

Note that "_zulip" will be automatically appended to the IRC nick provided

Example

./irc-mirror.py --irc-server=irc.freenode.net --channel='#python-mypy' --nick-prefix=irc_mirror \
--stream='test here' --topic='#mypy' \
--site="https://chat.zulip.org" --user=<bot-email> \
--api-key=<bot-api-key>