From 294a728b0f3cf4c335923b7fbe6bd7e137a3fee3 Mon Sep 17 00:00:00 2001 From: nico Date: Mon, 1 Oct 2018 23:17:09 +0200 Subject: refactorization (#1) * changed all lineendings to lf * cleaned up main class * refactor bot * refactor bot functions * moved functions.py to classes dir * code comment changes * changed code comment style - removed unnecessary pass statement + added missing newline * simplified function and return statements --- README.MD | 84 +++++++++++++++++++++++++++++++-------------------------------- 1 file changed, 42 insertions(+), 42 deletions(-) (limited to 'README.MD') diff --git a/README.MD b/README.MD index f7e4385..0672ba5 100644 --- a/README.MD +++ b/README.MD @@ -1,43 +1,43 @@ -# Python XMPP Chatbot - -## beforehand -Do not opperate this bot on foreign servers. - -### functions -- query xmpp server software and version [XEP-0092](https://xmpp.org/extensions/xep-0092.html) -- query xmpp server uptime [XEP-0012](https://xmpp.org/extensions/xep-0012.html) -- query xmpp server contact addresses [XEP-0157](https://xmpp.org/extensions/xep-0157.html) -- display help output -- respond to username being mentioned - -### todo -- [ ] Github Webhook - -### install -#### requirements -- slixmpp -- configparser -- datetime -- random -- validators - -#### configuration -`bot.cfg` replace dummy file with correct credentials/ parameters -````cfg -[Account] -jid=nick@domain.tld/querybot-0.1 -password=super_secret_password -[MUC] -rooms=room_to_connect_to@conference.domain.tld -nick=mucnickname -[ADMIN] -admins=admins ( ! muc nick and not the jid nickname) -```` - -##### systemd -Copy the systemd dummy file into systemd service folder. -`systemdctl daemon-reload` and `systemctl start magicbot.service` to start the bot. -If it is neccecary to start the bot automatically when the system boots do `systemctl enable magicbot.service`. - -#### starting the bot without systemd +# Python XMPP Chatbot + +## beforehand +Do not opperate this bot on foreign servers. + +### functions +- query xmpp server software and version [XEP-0092](https://xmpp.org/extensions/xep-0092.html) +- query xmpp server uptime [XEP-0012](https://xmpp.org/extensions/xep-0012.html) +- query xmpp server contact addresses [XEP-0157](https://xmpp.org/extensions/xep-0157.html) +- display help output +- respond to username being mentioned + +### todo +- [ ] Github Webhook + +### install +#### requirements +- slixmpp +- configparser +- datetime +- random +- validators + +#### configuration +`bot.cfg` replace dummy file with correct credentials/ parameters +````cfg +[Account] +jid=nick@domain.tld/querybot-0.1 +password=super_secret_password +[MUC] +rooms=room_to_connect_to@conference.domain.tld,another_room@conference.domain.tld +nick=mucnickname +[ADMIN] +admins=admins ( ! muc nick and not the jid nickname) +```` + +##### systemd +Copy the systemd dummy file into systemd service folder. +`systemdctl daemon-reload` and `systemctl start magicbot.service` to start the bot. +If it is neccecary to start the bot automatically when the system boots do `systemctl enable magicbot.service`. + +#### starting the bot without systemd Got to the bots directory and run `./main.py &`. \ No newline at end of file -- cgit v1.2.3-18-g5258