MozDef/bot
Brandon Myers e16ec577bf
Remove .keys() call during key exists comparison
2019-02-15 12:11:15 -06:00
..
irc Remove .keys() call during key exists comparison 2019-02-15 12:11:15 -06:00
slack Remove .keys() call during key exists comparison 2019-02-15 12:11:15 -06:00
README.md Convert readme for each bot into parent readme 2019-01-16 11:10:38 -06:00

README.md

MozDef Bot

Available Options

We currently support the following options. Our default is to use slack, but if you would like to use some other protocol besides slack, there is a requirements file in each of the sub directories that you will need to install.

Slack

SlackClient

We currently use https://github.com/slackapi/python-slackclient as our library to interact with Slack.

Installation

By default, our requirements.txt file includes the slackbot dependency, so no additional steps are needed for installation

IRC

KitnIRC - A Python IRC Bot Framework

KitnIRC is an IRC framework that attempts to handle most of the monotony of writing IRC bots without sacrificing flexibility.

Installation
pip install -r bot/irc/requirements.txt
Usage

See the skeleton directory in the root level for a starting code skeleton you can copy into a new project's directory and build off of, and Getting Started for introductory documentation.

License

KitnIRC is licensed under the MIT License (see LICENSE for details).

Other Resources

Useful reference documents for those working with the IRC protocol as a client: