decentral1se/xbotlib
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Formatting and line mangling

Browse Source
This commit is contained in:
Luke Murphy 2021-01-10 19:35:39 +01:00
parent 6167849884
commit dfaa551b3c
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -9,11 +9,10 @@
A friendly lightweight wrapper around A friendly lightweight wrapper around
[slixmpp](https://slixmpp.readthedocs.io/) for writing XMPP bots in Python. The [slixmpp](https://slixmpp.readthedocs.io/) for writing XMPP bots in Python. The
goal is to make writing and running XMPP bots easy and fun. goal is to make writing and running XMPP bots easy and fun. `xbotlib` is a
[single file implementation](./xbotlib.py) which can easily be understood and
`xbotlib` is a [single file implementation](./xbotlib.py) which can easily be extended. It provides a small API surface which reflects the `slixmpp` way of
understood and extended. It provides a small API surface which reflects the doing things.
`slixmpp` way of doing things.
## Install ## Install
@ -23,6 +22,8 @@ $ pip install xbotlib
## Example ## Example
Put the following in a `echo.py` file.
```python ```python
from xbotlib import Bot from xbotlib import Bot
@ -35,8 +36,9 @@ MyBot()
``` ```
And then `python echo.py`. You will be asked a few questions like which account 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 details your bot will be using.
same working directory for further use.
This will generate a `bot.conf` file in the same working directory for further use.
## More Examples ## More Examples