Python Security Toolkit Files

Python Security Toolkit
IRC Bot
http://pythonsecuritytoolkit.sourceforge.net/

This program is written in Python 3.  Please run it with a Python 3 interpreter.

Python Security Toolkit is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Python Security Toolkit is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.





Setup Instructions
---------------------------------------------------------------------------------------------------

Usage:
This program is written in Python 3 and must be ran in a Python 3 interpreter.
Execute the program from a command line console with the Python 3 interpreter.
Example:  command_prompt>python irc_bot.py



After executing the program you will be prompted for information to make the bot work.

First enter the IRC server you want to connect to.
Example:
    Enter server to connect to:  irc.server.com



Second enter the channel you want the bot to join.
(Don't forget to put the # at the beginning when you enter your channel.)
Example:
    Enter the channel to join:  #my_channel



Third enter the nick you wish to use for the bot.
Example:
    Enter bot's nick:  MyBot



Fourth enter the bot's real name.
Example:
    Enter bot's real name:  My Bot



Fifth enter your IRC nick to add to the list of authorized users.
(WARNING! You must enter your IRC nick here, if you do not then the bot won't respond to you.)
Example:
    Enter your IRC nick to add to list of authorized users:  MyNick



Last you must enter if you want the bot's log saved to a file.
Example:
    Do you wish to save the IRC log to a file? (y/n):  n
If you select n then the IRC log will be printed to the console only.

or

Example:
    Do you wish to save the IRC log to a file? (y/n):  y
If you select y then you will be prompted for a file to save the log too.

Example:
    Enter name for log file:  my_log.txt




Usage Instructions:
---------------------------------------------------------------------------------------------------
To command the bot your nick must be in the list of authorized users.
To command the bot send the bot a private message with a command.

                          
example:
                          
/msg botsnick $op mynick
(where botsnick is the nickname you have designated of the bot, and mynick is the nick of the person you want to op)
**** bot sets mynick to op ****
                          
                          
parameters are designated with < >
(this means substitute the name of the channel or nick, etc... at these places, leave out the < > when you type yours in!)
                          
                          
----Command list with parameters----    ----Description of what the commands make the bot do ----
                          
$op <channel> <nick>                    ---gives ops to specified user in specified channel
$deop <channel> <nick>                  ---removes ops for specified user in specified channel
$kick <channel> <nick>                  ---kicks specified user in specified channel
$inv <channel> <nick>                   ---invites specified user to specified channel
$nick <new nick>                        ---changes nick of bot
$join <channel>                         ---joins channel
$leave <channel>                        ---leaves channel
$quit                                   ---disconnects from server
$setname <real name>                    ---sets real name of bot
$topic <channel> <new topic>            ---sets topic for specified channel
$privmsg <nick> <message>               ---private msgs user
$msg <channel> <message>                ---sends message to specified channel
$voice <channel> <nick>                 ---gives voice to a user of specified channel
$half <channel> <nick>                  ---gives halfops to a user of specified channel
$admin <channel> <nick>                 ---gives admin to a user of specified channel
$owner <channel> <nick>                 ---gives owner status of specified channel to a user
$ban <channel> <nick!ident@host>        ---bans a user <nick!ident@host> from specified channel
$unban <channel> <nick!ident@host>      ---unbans a user <nick!ident@host> from specified channel
$adduser <nick>                         ---adds nick to the list of authorized users
$rmuser <nick>                          ---removes nick from the list of authorized users
$users                                  ---sends list of authorized users to user in private message
$help                                   ---sends bot instructions to user in private message