boots/README.md

# boots

## Description

This project is an attempt to write a fully featured IRC bot. I am learning to write code in python and get better at it.
If you are reading this then you are welcome to contribute code, reviews are a part of learning programming =)

# Requirements
This code only requires one dependency; [bottom](https://github.com/numberoverzero/bottom).

## 8ball

The `Eightball` class gives the bot the ability to support the iconic 8Ball game.
It will only answer to the `keyword` provided to the `Eightball` object.

# Admin

The `Admin` module provides the ability to add bot administrators who can request some destructive actions that might put the bot itself being abused like `join`, `part` and `quit`.

# TODO

- A better way to handle help pages
Second commit: * Adding an 8ball game * Adding an admin manager * Creating the bot shell 2017-09-07 00:39:32 +00:00			`# boots`

			`## Description`

			`This project is an attempt to write a fully featured IRC bot. I am learning to write code in python and get better at it.`
			`If you are reading this then you are welcome to contribute code, reviews are a part of learning programming =)`

			`# Requirements`
			`This code only requires one dependency; [bottom](https://github.com/numberoverzero/bottom).`

			`## 8ball`

			The `Eightball` class gives the bot the ability to support the iconic 8Ball game.
			It will only answer to the `keyword` provided to the `Eightball` object.

			`# Admin`

Changes of behaviour of how the Admin plugin handles the events This is a big commit: - Now the Admin class will not take any action only triggers an ADMIN event that can be consumed later by AdminCmd - AdminCmd now handles the commands allowed to the admins in a sane and clean way by consuming ADMIN events - Fixed the way the code exits, now it exits the loop cleanly everytime - Added a lot of functions to the Admin class which allows adding and removing administrators on the fly - Added a list of functions that will reply back a help page to the user 2017-09-09 04:29:55 +00:00			The `Admin` module provides the ability to add bot administrators who can request some destructive actions that might put the bot itself being abused like `join`, `part` and `quit`.

			`# TODO`

			`- A better way to handle help pages`