XMPP bots for humans
Project description
xbotlib
XMPP bots for humans
status: experimental
A friendly lightweight wrapper around
slixmpp for writing XMPP bots in Python. The
goal is to make writing and running XMPP bots easy and fun. xbotlib is a
single file implementation which can easily be understood and
extended. It provides a small API surface which reflects the slixmpp way of
doing things.
Install
$ pip install xbotlib
Example
Put the following in a echo.py file.
from xbotlib import Bot
class EchoBot(Bot):
def react(self, message):
if message.type == "chat":
self.reply(message.body, to=message.sender)
MyBot()
And then python echo.py. You will be asked a few questions like which account
details your bot will be using.
This will generate a bot.conf file in the same working directory for further use.
More Examples
- EchoBot: Sends back what you sent it
- WhisperBot: Pseudo-anonymous whispering in group chats
See the examples directoy for all listings.
API Reference
Your bot always sub-classes the Bot class provided from xbotlib. All
underling functions can be extended. For example, if you want to enable more
plugins or add different functionality. If something feels awkward then please
raise a ticket for that. Seamlessness is still a bitch but we're trying anyway.
Bot.react(message)
A function which you define in your bot implementation in order to respond to
chat messages. You can respond to both direct messages and group chat messages
in this function by checking the message.type which can be either chat or
groupchat.
Arguments:
- message: sent message and metadata (see message reference below)
Bot.reply(body, to=None, room=None)
Send back a response to a direct chat message.
Arguments:
- body: the message to send
- to: which user account to reply to (direct chat)
- room: which room to reply to (group chat)
EasyMessage
A simple message format. This is the type that you work with when your function
accepts a message argument.
Attributes:
- body: the body of the message
- sender: the sender of the message
- receive: the receive of the message
- nickname: the nickname of the sender
- type: the type of message (
chatorgroupchat)
Configure your bot
Using the environment
You can pass the --no-input option to your script invocation (e.g. python bot.py --no-input).
xbotlib will try to read the following configuration values from the environment.
- XBOT_JID
- XBOT_PASSWORD
- XBOT_ROOM
- XBOT_NICK
Roadmap
See the issue tracker.
Changes
See the CHANGELOG.md.
License
See the LICENSE.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file xbotlib-0.3.1.tar.gz.
File metadata
- Download URL: xbotlib-0.3.1.tar.gz
- Upload date:
- Size: 16.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.9.0 Linux/4.19.0-13-amd64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 84dbe5d3ec6416bd592e3b75e6243144ad6f16c98035ff368da20de309076735 |
|
| MD5 | e8ed20aace15a851c75460cd954ffd9d |
|
| BLAKE2b-256 | 1c25aa88f2bb4c0fb378de5ea4464b62b7349a78ac468f1f961bb68ba0bc3a1c |
File details
Details for the file xbotlib-0.3.1-py3-none-any.whl.
File metadata
- Download URL: xbotlib-0.3.1-py3-none-any.whl
- Upload date:
- Size: 16.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.9.0 Linux/4.19.0-13-amd64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5c9d33f02573d47a6ed1e95d1be77b214376135f2d5b2e2afb49b97c16671302 |
|
| MD5 | ae52d086103555c2fbc88be7aeb34678 |
|
| BLAKE2b-256 | cb181b9491b4cf4661525395d4ad4d553e9d0dee17b4489ee2d25d35a1515143 |
