1  IRC Bots
 2  ========
 3  
 4  ## `meetbot`
 5  
 6  `meetbot.py` is a bot used to keep topics for IRC channels, that can
 7  be discussed on meetings. Multiple channels can be configured and this
 8  is done through `meetbot_cfg.py`.
 9  
10  **Notes:**
11  * Never add secrets to the public repo config!
12  
13  ### Setup
14  
15  * Download `meetbot.py` and `meetbot_cfg.py` 
16  * Edit `meetbot_cfg.py` for your needs.
17  * Navigate terminal to the folder where `meetbot.py` is.
18  * Run the bot: `$ python meetbot.py`
19  
20  ## `titlebot`
21  `titlebot.py` is a bot used to print the title of a website provided by
22  a link in a `PRIVMSG`.
23  
24  ## `tweetifier`
25  `tweetifier` is yet another bot that recognizes Twitter links, fetch
26  the tweet text and print it out in irc.
27  
28  ## `taubot`
29  sends notifications about some `tau` commands (namely: adding or 
30  stopping a task, changing state, reassigning and new comments) to 
31  desired channels in `darkirc`. 
32  
33  ## `mirror-bot`
34  sends a copy of the message sent in an IRC server to another.
35  
36  ## `commitbot`
37  sends notifications about pushed code to `github` to desired channels 
38  in `darkirc`. 
39  
40  ## `test-bot`
41  sends a response to user sent 'test' or 'echo' `PrivMsg`s.
42  
43  ## Setup
44  
45  * Create a new darkirc config for the bot.
46  * Edit the config for your needs.
47  * Run a `darkirc` instance, make sure to point it to the new config.
48  * Run the bot script.
49  
50  
51  ## Run
52  
53  ### Using a venv
54  
55  All these bots are working on and require Python 3.12.7. Make sure 
56  Python is installed and on the latest version.
57  
58  Depending on your setup you may need to install a virtual environment
59  for Python. Do so as follows:
60  
61  ```shell
62  % python -m venv venv_{bot_name}
63  % source venv_{bot_name}/bin/activate
64  ```
65  
66  Then install the requirements:
67  
68  ```shell
69  % pip install -r requirements_{bot_name}.txt
70  ```
71  
72  Run bot:
73  
74  ```shell
75  % python {bot_script}.py
76  ```
77  
78  You will need to reactivate the venv in your current terminal session
79  each time you use the bot as follows:
80  
81  ```shell
82  % source venv_{bot_name}/bin/activate
83  ```
84  
85  ### Without a venv
86  
87  If you don't require a venv, install the requirements and run needed bot as follows:
88  
89  ```shell
90  % pip install -r requirements.txt
91  % python {bot_script}.py
92  ```
93  
94  **Notes:**
95  * Make sure the `irc_listen` is the same in config and in bot script.