<commit_before># alebot

alebot is a lean and super modular python IRC bot with awesome extendability.

## Quickstart
Download this repository, create a `config.json` in the root folder and add as many as you need of the following settings (none required, you are seeing the defaults)[^1]:

```json
{
    "nick": "alebot", // nick
    "ident": "alebot", // ident
    "realname": "alebot python irc bot. https://github/alexex/alebot", // realname
    "server": "irc.freenode.net", // server
    "port": 6667, // port to use
    "channels": [] // list of channels to join
}
```


Then start the bot with `./run.py` or `python run.py`.

All the working plugins in the `plugins` folder will automatically be activated.

## Writing plugins

To find out how to write plugins, check out the the documentation of the `Hook` and `Task` classes (second one is optional) and see the `default.py` plugin that provides basic funtionality like the ping-pong-behavior.

[^1]: actually even creating a config file is optional.<commit_msg>kill readme in favor of docs.<commit_after># alebot

alebot is a super lean and completely modularized IRC bot written in python for people who like the python way.

## Getting started

Check out the [alebot docs](http://alebot.readthedocs.org/en/latest/) for more info.
{'fraction_non_alphanumeric': 0.1021671826625387, 'fraction_numerical': 0.0046439628482972135, 'mean_word_length': 3.879245283018868, 'pattern_counts': {'":': 6, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5116040', 'n_tokens_mistral': 380, 'n_tokens_neox': 360, 'n_words': 174}