nemunaire
/
nemubot
1
0
Fork 0
Code Releases Activity
An extremely modulable IRC bot, built around XML configuration files.
874 Commits 16 Branches 5 Tags 1.4 MiB
Python 99.9%
Dockerfile 0.1%
Go to file
nemunaire 26f301d6b4 events: Use the new data parser, knodes based 2017-09-02 12:49:19 +02:00
bin Welcome in 2016... Happy new year! 2016-04-08 12:55:24 +02:00
modules events: Use the new data parser, knodes based 2017-09-02 12:49:19 +02:00
nemubot WIP Simplify ModuleEvent with functools package 2017-09-02 12:49:19 +02:00
.gitignore Use a logger 2014-08-14 12:50:19 +02:00
.travis.yml Run core tests in CI 2015-10-19 17:15:42 +02:00
AUTHORS Add conf sample, README, licence, AUTHORS 2012-06-28 22:09:59 +02:00
COPYING Introduce nemubot v3.2 2012-08-14 05:51:55 +02:00
README.md Start using asyncio for signals 2017-09-02 12:49:18 +02:00
bot_sample.xml Rework XML parser: part 1 2015-10-28 10:55:02 +01:00
requirements.txt Add a build system 2015-10-16 16:39:51 +02:00
setup.py Remove legacy prompt 2017-07-14 12:35:55 +02:00
speak_sample.xml Convert nemuspeak as a module to nemubot 2014-10-27 18:40:04 +01:00

README.md

nemubot

An extremely modulable IRC bot, built around XML configuration files!

Requirements

nemubot requires at least Python 3.4 to work, as it uses asyncio.

Connecting to SSL server requires this patch.

Some modules (like cve, nextstop or laposte) require the BeautifulSoup module, but the core and framework has no dependency.

Installation

Use the setup.py file: python setup.py install.

VirtualEnv setup

The easiest way to do this is through a virtualenv:

virtualenv venv
. venv/bin/activate
python setup.py install

Create a new configuration file

There is a sample configuration file, called bot_sample.xml. You can create your own configuration file from it.

Usage

Don't forget to activate your virtualenv in further terminals, if you use it.

To launch the bot, run:

nemubot bot.xml

Where bot.xml is your configuration file.