https://github.com/poezio/slixmpp

SleekXMPP fork using asyncio, for poezio - Github copy
https://github.com/poezio/slixmpp

library python xmpp xmpp-client-library xmpp-components

Last synced: 3 months ago
JSON representation

SleekXMPP fork using asyncio, for poezio - Github copy

• Host: GitHub
• URL: https://github.com/poezio/slixmpp
• Owner: poezio
• License: other
• Archived: true
• Created: 2014-11-12T21:17:50.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2023-08-01T08:20:03.000Z (over 1 year ago)
• Last Synced: 2024-09-23T07:43:00.507Z (3 months ago)
• Topics: library, python, xmpp, xmpp-client-library, xmpp-components
• Language: Python
• Homepage: https://codeberg.org/poezio/slixmpp
• Size: 7.08 MB
• Stars: 113
• Watchers: 9
• Forks: 54
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Slixmpp

#########

Slixmpp is an MIT licensed XMPP library for Python 3.7+. It is a fork of

SleekXMPP.

Slixmpp's goals is to only rewrite the core of the library (the low level

socket handling, the timers, the events dispatching) in order to remove all

threads.

Building

--------

Slixmpp can make use of cython to improve performance on critical modules.

To do that, **cython3** is necessary along with **libidn** headers.

Otherwise, no compilation is needed. Building is done by running setup.py::

    python3 setup.py build_ext --inplace

Documentation and Testing

-------------------------

Documentation can be found both inline in the code, and as a Sphinx project in ``/docs``.

To generate the Sphinx documentation, follow the commands below. The HTML output will

be in ``docs/_build/html``::

    cd docs

    make html

    open _build/html/index.html

To run the test suite for Slixmpp::

    python run_tests.py

Integration tests require the following environment variables to be set:::

    $CI_ACCOUNT1

    $CI_ACCOUNT1_PASSWORD

    $CI_ACCOUNT2

    $CI_ACCOUNT2_PASSWORD

    $CI_MUC_SERVER

where the account variables are JIDs of valid, existing accounts, and

the passwords are the account passwords. The MUC server must allow room

creation from those JIDs.

To run the integration test suite for Slixmpp::

    python run_integration_tests.py

The Slixmpp Boilerplate

-------------------------

Projects using Slixmpp tend to follow a basic pattern for setting up client/component

connections and configuration. Here is the gist of the boilerplate needed for a Slixmpp

based project. See the documentation or examples directory for more detailed archetypes for

Slixmpp projects::

    import logging

    from slixmpp import ClientXMPP

    from slixmpp.exceptions import IqError, IqTimeout

    class EchoBot(ClientXMPP):

        def __init__(self, jid, password):

            ClientXMPP.__init__(self, jid, password)

            self.add_event_handler("session_start", self.session_start)

            self.add_event_handler("message", self.message)

            # If you wanted more functionality, here's how to register plugins:

            # self.register_plugin('xep_0030') # Service Discovery

            # self.register_plugin('xep_0199') # XMPP Ping

            # Here's how to access plugins once you've registered them:

            # self['xep_0030'].add_feature('echo_demo')

            # If you are working with an OpenFire server, you will

            # need to use a different SSL version:

            # import ssl

            # self.ssl_version = ssl.PROTOCOL_SSLv3

        def session_start(self, event):

            self.send_presence()

            self.get_roster()

            # Most get_*/set_* methods from plugins use Iq stanzas, which

            # can generate IqError and IqTimeout exceptions

            #

            # try:

            #     self.get_roster()

            # except IqError as err:

            #     logging.error('There was an error getting the roster')

            #     logging.error(err.iq['error']['condition'])

            #     self.disconnect()

            # except IqTimeout:

            #     logging.error('Server is taking too long to respond')

            #     self.disconnect()

        def message(self, msg):

            if msg['type'] in ('chat', 'normal'):

                msg.reply("Thanks for sending\n%(body)s" % msg).send()

    if __name__ == '__main__':

        # Ideally use optparse or argparse to get JID,

        # password, and log level.

        logging.basicConfig(level=logging.DEBUG,

                            format='%(levelname)-8s %(message)s')

        xmpp = EchoBot('[email protected]', 'use_getpass')

        xmpp.connect()

        xmpp.process(forever=True)

Slixmpp Credits

---------------

**Maintainers:**

    - Florent Le Coz (`[email protected] `_),

    - Mathieu Pasquet (`[email protected] `_),

**Contributors:**

    - Emmanuel Gil Peyrot (`Link mauve `_)

    - Sam Whited (`Sam Whited `_)

    - Dan Sully (`Dan Sully `_)

    - Gasper Zejn (`Gasper Zejn `_)

    - Krzysztof Kotlenga (`Krzysztof Kotlenga `_)

    - Tsukasa Hiiragi (`Tsukasa Hiiragi `_)

    - Maxime Buquet (`pep `_)

Credits (SleekXMPP)

-------------------

**Main Author:** Nathan Fritz

    `[email protected] `_,

    `@fritzy `_

    Nathan is also the author of XMPPHP and `Seesmic-AS3-XMPP

    `_, and a former member of

    the XMPP Council.

**Co-Author:** Lance Stout

    `[email protected] `_,

    `@lancestout `_

**Contributors:**

    - Brian Beggs (`macdiesel `_)

    - Dann Martens (`dannmartens `_)

    - Florent Le Coz (`louiz `_)

    - Kevin Smith (`Kev `_, http://kismith.co.uk)

    - Remko Tronçon (`remko `_, http://el-tramo.be)

    - Te-jé Rogers (`te-je `_)

    - Thom Nichols (`tomstrummer `_)