diff options
| author | nico <nico@magicbroccoli.de> | 2018-10-04 00:46:57 +0200 |
|---|---|---|
| committer | nico <nico@magicbroccoli.de> | 2018-10-04 00:46:57 +0200 |
| commit | 6bb9f1d5b87537ed6bccf0dd6efb7b80c6a81395 (patch) | |
| tree | 5ed80aa6e5ba2a7addaef0e63286442a79f2849f /README.MD | |
| parent | 6c6c14b55fdbf3f79e21f961354952190b443a6b (diff) | |
readme + usability improvements
+ added requirements.txt
* updated readme
Diffstat (limited to 'README.MD')
| -rw-r--r-- | README.MD | 25 |
1 files changed, 16 insertions, 9 deletions
@@ -1,28 +1,35 @@ # Python XMPP Chatbot ## beforehand -Do not opperate this bot on foreign servers. +Do not operate this bot on foreign servers. Many servers prohibit the usage of bots on their service. ### 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 information about XEP from the [XSF extensions website](https://xmpp.org/extensions/) - display help output - respond to username being mentioned ### install -#### requirements -- slixmpp -- logging -- ssl -- configparser -- validators +#### virtualenv +With virtualenv it is possible to run the bot inside a virtual environment without disrupting other python processes + and or dependencies. This repo comes with a `requirements.txt` to make the install process as easy as possible. + ````bash +cd to_the_path/of_the_bot/ +mkdir ./venv + +# create the virtual environment +virtualenv -p $(which python3) ./venv +source ./venv/bin/activate +pip3 install -r requirements.txt +```` #### configuration -`bot.cfg` replace dummy file with correct credentials/ parameters +Replace the dummy `bot.cfg` file, filled with correct credentials/ parameters. ````cfg [Account] -jid=nick@domain.tld/querybot-0.1 +jid=nick@domain.tld/querybot password=super_secret_password [MUC] rooms=room_to_connect_to@conference.domain.tld,another_room@conference.domain.tld |