| About: | Python 2/3 implementation of XMPP |
|---|---|
| Standards: | RFC3920, RFC3921 |
| Documentation: | https://xmpppy.sourceforge.net/ |
| Source Code: | https://github.com/xmpppy/xmpppy |
Using pip, you can install the package with:
pip install --upgrade xmpppy
Regularly, the module is used as a library, like:
import xmpp
jabberid = "foobar@xmpp.domain.tld"
password = "secret"
receiver = "bazqux@xmpp.domain.tld"
message = "hello world"
def main():
jid = xmpp.protocol.JID(jabberid)
connection = xmpp.Client(server=jid.getDomain(), debug=True)
connection.connect()
connection.auth(user=jid.getNode(), password=password, resource=jid.getResource())
connection.send(xmpp.protocol.Message(to=receiver, body=message))
if __name__ == "__main__":
main()
The package also installs a command line program called xmpp-message.
Its synopsis is:
xmpp-message --debug \
--jabberid foobar@xmpp.domain.tld --password secret \
--receiver bazqux@xmpp.domain.tld --message 'hello world'
You can also put your credentials into an ~/.xsend file, like:
JID=foobar@xmpp.domain.tld PASSWORD=secret
and then invoke xmpp-message omitting the --jabberid and --password options, like:
xmpp-message --receiver bazqux@xmpp.domain.tld --message 'hello world'
The canonical documentation is hosted at https://xmpppy.github.io/ and http://xmpppy.sourceforge.net/.
For learning about how to use this module, please have a look at these spots within the code base.
- The
xmpp-messageprogram, located atxmpp/cli.py, for sending a single XMPP message. - The other programs within the
doc/examplesdirectory. - The docstrings within the library itself.
Acquire sources and bootstrap sandbox:
git clone https://github.com/xmpppy/xmpppy cd xmpppy python3 -m venv .venv source .venv/bin/activate pip install --upgrade --editable='.[test]'
Run software tests:
docker compose --file tests/compose.yml up pytest
If you have any questions about xmpppy usage or you have found a bug or want to share some ideas - you are welcome to join us on the issue tracker or on the xmpppy-devel mailing list.