Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple IRC Notification framework for regular tasks

What it does?

  • ircme.py reads settings.yaml which contains your irc settings (server, botname, channel) and your jobs (python file + how often it should be executed e.g every 60 minutes)
  • a job is a simple python file. ireqme.py will load it during runtime and execute the go function

If you want to try it

git clone https://github.com/kmille/IRCme.git /home/ircme/IRCme
cd /home/ircme/IRCme
python3 -m virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
check the settings.py (for testing you can just run ping.py from the modules directory)
python ircme.py

Persistence

adduser --shell /usr/sbin/nologin --disabled-password ircme
chown -R ircme: /home/ircme/IRCme/
cp ircme.service /etc/systemd/system
systemctl daemon-reload

Configuration (check settings.yaml)

irc
- nickname is the name of the bot
- target can be a channel (e.g. #test123) or an irc username

jobs
- list containing python_file and every_minutes (60 for run it every 60 minutes)

Trigger the bot manually

supported commands are (you have to mention the botname like 'bot43: list'):

command what it does
list shows all jobs listed in settings.yaml
do executes a job (e.g do ping.py

About

Simple IRC Notification framework for regular tasks

Topics

Resources

Stars

1 star

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages