https://github.com/xmpppy/xmpppy

Python 2/3 implementation of XMPP
https://github.com/xmpppy/xmpppy

jabber jabber-client xmpp xmpp-client xmpp-client-library xmpp-library

Last synced: about 15 hours ago
JSON representation

Python 2/3 implementation of XMPP

• Host: GitHub
• URL: https://github.com/xmpppy/xmpppy
• Owner: xmpppy
• License: gpl-3.0
• Created: 2009-06-28T12:54:48.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2023-12-01T09:07:48.000Z (about 1 year ago)
• Last Synced: 2024-12-15T02:06:32.638Z (8 days ago)
• Topics: jabber, jabber-client, xmpp, xmpp-client, xmpp-client-library, xmpp-library
• Language: Python
• Homepage: http://xmpppy.sourceforge.net/
• Size: 613 KB
• Stars: 102
• Watchers: 12
• Forks: 65
• Open Issues: 18
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
######

xmpppy

######

    *Python 2/3 implementation of XMPP (RFC3920, RFC3921).*

----

**Documentation**: http://xmpppy.sf.net/

**Source Code**: https://github.com/xmpppy/xmpppy

**Status**:

.. image:: https://img.shields.io/pypi/pyversions/xmpppy.svg

    :target: https://pypi.org/project/xmpppy/

.. image:: https://img.shields.io/pypi/v/xmpppy.svg

    :target: https://pypi.org/project/xmpppy/

.. image:: https://img.shields.io/pypi/l/xmpppy.svg

    :target: https://pypi.org/project/xmpppy/

.. image:: https://img.shields.io/pypi/dm/xmpppy.svg

    :target: https://pypi.org/project/xmpppy/

----

*****

About

*****

This library has been written to be compliant with

`RFC3920 `_

and

`RFC3921 `_.

************

Installation

************

Using ``pip``, you can install the package with::

    pip install xmpppy --upgrade

*****

Usage

*****

As a library

============

Regularly, the module is used as a library, like::

    import xmpp

    jabberid = "[email protected]"

    password = "secret"

    receiver = "[email protected]"

    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()

Command line interface

======================

The package also installs a command line program called ``xmpp-message``.

Its synopsis is::

    xmpp-message --debug \

        --jabberid [email protected] --password secret \

        --receiver [email protected] --message 'hello world'

You can also put your credentials into an ``~/.xsend`` file, like::

    [email protected]

    PASSWORD=secret

and then invoke ``xmpp-message`` omitting the ``--jabberid`` and ``--password`` options, like::

    xmpp-message --receiver [email protected] --message 'hello world'

*************

Documentation

*************

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-message`` program, located at ``xmpp/cli.py``, for sending a single XMPP message.

- The other programs within the ``doc/examples`` directory.

- The docstrings within the library itself.

*******

Support

*******

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 `_.

**************

Other projects

**************

- https://github.com/poezio/slixmpp

- https://github.com/horazont/aioxmpp

- https://github.com/Jajcus/pyxmpp2

- https://github.com/fritzy/SleekXMPP

- https://dev.gajim.org/gajim/python-nbxmpp

- https://github.com/xmpppy/xmpppy/files/4346179/xmpp_libs.xlsx