From 5ab77c745270d7d5c016c1dc7ef2a82533a4b16e Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Thu, 17 Jul 2014 14:19:04 +0200 Subject: Rename to slixmpp --- docs/Makefile | 8 +-- docs/api/basexmpp.rst | 2 +- docs/api/clientxmpp.rst | 2 +- docs/api/componentxmpp.rst | 2 +- docs/api/exceptions.rst | 2 +- docs/api/xmlstream/filesocket.rst | 2 +- docs/api/xmlstream/handler.rst | 6 +- docs/api/xmlstream/jid.rst | 2 +- docs/api/xmlstream/matcher.rst | 10 +-- docs/api/xmlstream/scheduler.rst | 2 +- docs/api/xmlstream/stanzabase.rst | 14 ++-- docs/api/xmlstream/tostring.rst | 8 +-- docs/api/xmlstream/xmlstream.rst | 2 +- docs/architecture.rst | 34 +++++----- docs/conf.py | 12 ++-- docs/create_plugin.rst | 58 ++++++++--------- docs/event_index.rst | 124 ++++++++++++++++++------------------ docs/getting_started/component.rst | 18 +++--- docs/getting_started/echobot.rst | 68 ++++++++++---------- docs/getting_started/iq.rst | 54 ++++++++-------- docs/getting_started/muc.rst | 24 +++---- docs/getting_started/proxy.rst | 6 +- docs/getting_started/sendlogout.rst | 20 +++--- docs/guide_xep_0030.rst | 4 +- docs/index.rst | 36 +++++------ docs/make.bat | 4 +- docs/xmpp_tdg.rst | 20 +++--- 27 files changed, 272 insertions(+), 272 deletions(-) (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile index a520f6a1..d44cd8a4 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -72,17 +72,17 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SleekXMPP.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Slixmpp.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SleekXMPP.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Slixmpp.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/SleekXMPP" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SleekXMPP" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Slixmpp" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Slixmpp" @echo "# devhelp" epub: diff --git a/docs/api/basexmpp.rst b/docs/api/basexmpp.rst index fa96322e..df05bb0b 100644 --- a/docs/api/basexmpp.rst +++ b/docs/api/basexmpp.rst @@ -2,7 +2,7 @@ BaseXMPP ======== -.. module:: sleekxmpp.basexmpp +.. module:: slixmpp.basexmpp .. autoclass:: BaseXMPP :members: diff --git a/docs/api/clientxmpp.rst b/docs/api/clientxmpp.rst index a6f32c43..232c37c3 100644 --- a/docs/api/clientxmpp.rst +++ b/docs/api/clientxmpp.rst @@ -2,7 +2,7 @@ ClientXMPP ========== -.. module:: sleekxmpp.clientxmpp +.. module:: slixmpp.clientxmpp .. autoclass:: ClientXMPP :members: diff --git a/docs/api/componentxmpp.rst b/docs/api/componentxmpp.rst index 989120c2..9c6366aa 100644 --- a/docs/api/componentxmpp.rst +++ b/docs/api/componentxmpp.rst @@ -2,7 +2,7 @@ ComponentXMPP ============= -.. module:: sleekxmpp.componentxmpp +.. module:: slixmpp.componentxmpp .. autoclass:: ComponentXMPP :members: diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst index 7bc72ce5..0736a09c 100644 --- a/docs/api/exceptions.rst +++ b/docs/api/exceptions.rst @@ -1,7 +1,7 @@ Exceptions ========== -.. module:: sleekxmpp.exceptions +.. module:: slixmpp.exceptions .. autoexception:: XMPPError diff --git a/docs/api/xmlstream/filesocket.rst b/docs/api/xmlstream/filesocket.rst index 35f44019..eff062d8 100644 --- a/docs/api/xmlstream/filesocket.rst +++ b/docs/api/xmlstream/filesocket.rst @@ -1,4 +1,4 @@ -.. module:: sleekxmpp.xmlstream.filesocket +.. module:: slixmpp.xmlstream.filesocket .. _filesocket: diff --git a/docs/api/xmlstream/handler.rst b/docs/api/xmlstream/handler.rst index 33c0bf42..ab8091a3 100644 --- a/docs/api/xmlstream/handler.rst +++ b/docs/api/xmlstream/handler.rst @@ -3,14 +3,14 @@ Stanza Handlers The Basic Handler ----------------- -.. module:: sleekxmpp.xmlstream.handler.base +.. module:: slixmpp.xmlstream.handler.base .. autoclass:: BaseHandler :members: Callback -------- -.. module:: sleekxmpp.xmlstream.handler.callback +.. module:: slixmpp.xmlstream.handler.callback .. autoclass:: Callback :members: @@ -18,7 +18,7 @@ Callback Waiter ------ -.. module:: sleekxmpp.xmlstream.handler.waiter +.. module:: slixmpp.xmlstream.handler.waiter .. autoclass:: Waiter :members: diff --git a/docs/api/xmlstream/jid.rst b/docs/api/xmlstream/jid.rst index 22a2db45..1844b75a 100644 --- a/docs/api/xmlstream/jid.rst +++ b/docs/api/xmlstream/jid.rst @@ -1,7 +1,7 @@ Jabber IDs (JID) ================= -.. module:: sleekxmpp.xmlstream.jid +.. module:: slixmpp.xmlstream.jid .. autoclass:: JID :members: diff --git a/docs/api/xmlstream/matcher.rst b/docs/api/xmlstream/matcher.rst index df3591bc..793059f2 100644 --- a/docs/api/xmlstream/matcher.rst +++ b/docs/api/xmlstream/matcher.rst @@ -3,7 +3,7 @@ Stanza Matchers The Basic Matcher ----------------- -.. module:: sleekxmpp.xmlstream.matcher.base +.. module:: slixmpp.xmlstream.matcher.base .. autoclass:: MatcherBase :members: @@ -11,7 +11,7 @@ The Basic Matcher ID Matching ----------- -.. module:: sleekxmpp.xmlstream.matcher.id +.. module:: slixmpp.xmlstream.matcher.id .. autoclass:: MatcherId :members: @@ -19,7 +19,7 @@ ID Matching Stanza Path Matching -------------------- -.. module:: sleekxmpp.xmlstream.matcher.stanzapath +.. module:: slixmpp.xmlstream.matcher.stanzapath .. autoclass:: StanzaPath :members: @@ -27,7 +27,7 @@ Stanza Path Matching XPath ----- -.. module:: sleekxmpp.xmlstream.matcher.xpath +.. module:: slixmpp.xmlstream.matcher.xpath .. autoclass:: MatchXPath :members: @@ -35,7 +35,7 @@ XPath XMLMask ------- -.. module:: sleekxmpp.xmlstream.matcher.xmlmask +.. module:: slixmpp.xmlstream.matcher.xmlmask .. autoclass:: MatchXMLMask :members: diff --git a/docs/api/xmlstream/scheduler.rst b/docs/api/xmlstream/scheduler.rst index ff91701e..59752eca 100644 --- a/docs/api/xmlstream/scheduler.rst +++ b/docs/api/xmlstream/scheduler.rst @@ -2,7 +2,7 @@ Scheduler ========= -.. module:: sleekxmpp.xmlstream.scheduler +.. module:: slixmpp.xmlstream.scheduler .. autoclass:: Task :members: diff --git a/docs/api/xmlstream/stanzabase.rst b/docs/api/xmlstream/stanzabase.rst index f575299e..ec28bafe 100644 --- a/docs/api/xmlstream/stanzabase.rst +++ b/docs/api/xmlstream/stanzabase.rst @@ -4,9 +4,9 @@ Stanza Objects ============== -.. module:: sleekxmpp.xmlstream.stanzabase +.. module:: slixmpp.xmlstream.stanzabase -The :mod:`~sleekmxpp.xmlstream.stanzabase` module provides a wrapper for the +The :mod:`~slixmpp.xmlstream.stanzabase` module provides a wrapper for the standard :mod:`~xml.etree.ElementTree` module that makes working with XML less painful. Instead of having to manually move up and down an element tree and insert subelements and attributes, you can interact with an object @@ -52,9 +52,9 @@ elements of the original XML chunk. .. seealso:: :ref:`create-stanza-interfaces`. -Because the :mod:`~sleekxmpp.xmlstream.stanzabase` module was developed +Because the :mod:`~slixmpp.xmlstream.stanzabase` module was developed as part of an `XMPP `_ library, these chunks of XML are -referred to as :term:`stanzas `, and in SleekXMPP we refer to a +referred to as :term:`stanzas `, and in Slixmpp we refer to a subclass of :class:`ElementBase` which defines the interfaces needed for interacting with a given :term:`stanza` a :term:`stanza object`. @@ -72,7 +72,7 @@ plugin stanza object. Here is an example: - + @@ -84,13 +84,13 @@ we can access the plugin as so:: >>> iq['disco_info'] ' - + ' We can then drill down through the plugin object's interfaces as desired:: >>> iq['disco_info']['identities'] - [('client', 'bot', 'SleekXMPP Bot')] + [('client', 'bot', 'Slixmpp Bot')] Plugins may also add new interfaces to the parent stanza object as if they had been defined by the parent directly, and can also override the behaviour diff --git a/docs/api/xmlstream/tostring.rst b/docs/api/xmlstream/tostring.rst index 82a8c2a5..8d75f1db 100644 --- a/docs/api/xmlstream/tostring.rst +++ b/docs/api/xmlstream/tostring.rst @@ -1,18 +1,18 @@ -.. module:: sleekxmpp.xmlstream.tostring +.. module:: slixmpp.xmlstream.tostring .. _tostring: XML Serialization ================= -Since the XML layer of SleekXMPP is based on :mod:`~xml.etree.ElementTree`, +Since the XML layer of Slixmpp is based on :mod:`~xml.etree.ElementTree`, why not just use the built-in :func:`~xml.etree.ElementTree.tostring` method? The answer is that using that method produces ugly results when using namespaces. The :func:`tostring()` method used here intelligently hides namespaces when able and does not introduce excessive namespace prefixes:: - >>> from sleekxmpp.xmlstream.tostring import tostring + >>> from slixmpp.xmlstream.tostring import tostring >>> from xml.etree import cElementTree as ET >>> xml = ET.fromstring('') >>> ET.tostring(xml) @@ -25,7 +25,7 @@ produce unexpected results depending on how the :func:`tostring()` method is invoked. For example, when sending XML on the wire, the main XMPP stanzas with their namespace of ``jabber:client`` will not include the namespace because that is already declared by the stream header. But, if -you create a :class:`~sleekxmpp.stanza.message.Message` instance and dump +you create a :class:`~slixmpp.stanza.message.Message` instance and dump it to the terminal, the ``jabber:client`` namespace will appear. .. autofunction:: tostring diff --git a/docs/api/xmlstream/xmlstream.rst b/docs/api/xmlstream/xmlstream.rst index 90a7a6af..ced2ed14 100644 --- a/docs/api/xmlstream/xmlstream.rst +++ b/docs/api/xmlstream/xmlstream.rst @@ -2,7 +2,7 @@ XML Stream ========== -.. module:: sleekxmpp.xmlstream.xmlstream +.. module:: slixmpp.xmlstream.xmlstream .. autoexception:: RestartStream diff --git a/docs/architecture.rst b/docs/architecture.rst index a2e0a27d..52bb8d9c 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -1,9 +1,9 @@ .. index:: XMLStream, BaseXMPP, ClientXMPP, ComponentXMPP -SleekXMPP Architecture +Slixmpp Architecture ====================== -The core of SleekXMPP is contained in four classes: ``XMLStream``, +The core of Slixmpp is contained in four classes: ``XMLStream``, ``BaseXMPP``, ``ClientXMPP``, and ``ComponentXMPP``. Along side this stack is a library for working with XML objects that eliminates most of the tedium of creating/manipulating XML. @@ -17,7 +17,7 @@ of the tedium of creating/manipulating XML. The Foundation: XMLStream ------------------------- -:class:`~sleekxmpp.xmlstream.xmlstream.XMLStream` is a mostly XMPP-agnostic +:class:`~slixmpp.xmlstream.xmlstream.XMLStream` is a mostly XMPP-agnostic class whose purpose is to read and write from a bi-directional XML stream. It also allows for callback functions to execute when XML matching given patterns is received; these callbacks are also referred to as :term:`stream @@ -26,7 +26,7 @@ which can be triggered either manually or on a timed schedule. The Main Threads ~~~~~~~~~~~~~~~~ -:class:`~sleekxmpp.xmlstream.xmlstream.XMLStream` instances run using at +:class:`~slixmpp.xmlstream.xmlstream.XMLStream` instances run using at least three background threads: the send thread, the read thread, and the scheduler thread. The send thread is in charge of monitoring the send queue and writing text to the outgoing XML stream. The read thread pulls text off @@ -34,7 +34,7 @@ of the incoming XML stream and stores the results in an event queue. The scheduler thread is used to emit events after a given period of time. Additionally, the main event processing loop may be executed in its -own thread if SleekXMPP is being used in the background for another +own thread if Slixmpp is being used in the background for another application. Short-lived threads may also be spawned as requested for threaded @@ -61,10 +61,10 @@ when this bit of XML is received (with an assumed namespace of new object is determined using a map of namespaced element names to classes. - Our incoming XML is thus turned into a :class:`~sleekxmpp.stanza.Message` + Our incoming XML is thus turned into a :class:`~slixmpp.stanza.Message` :term:`stanza object` because the namespaced element name ``{jabber:client}message`` is associated with the class - :class:`~sleekxmpp.stanza.Message`. + :class:`~slixmpp.stanza.Message`. 2. **Match stanza objects to callbacks.** @@ -73,14 +73,14 @@ when this bit of XML is received (with an assumed namespace of :term:`stanza object` is paired with a reference to the handler and placed into the event queue. - Our :class:`~sleekxmpp.stanza.Message` object is thus paired with the message stanza handler + Our :class:`~slixmpp.stanza.Message` object is thus paired with the message stanza handler :meth:`BaseXMPP._handle_message` to create the tuple:: ('stanza', stanza_obj, handler) 3. **Process the event queue.** - The event queue is the heart of SleekXMPP. Nearly every action that + The event queue is the heart of Slixmpp. Nearly every action that takes place is first inserted into this queue, whether that be received stanzas, custom events, or scheduled events. @@ -97,7 +97,7 @@ when this bit of XML is received (with an assumed namespace of Since a :term:`stream handler` shouldn't block, if extensive processing for a stanza is required (such as needing to send and receive an - :class:`~sleekxmpp.stanza.Iq` stanza), then custom events must be used. + :class:`~slixmpp.stanza.Iq` stanza), then custom events must be used. These events are not explicitly tied to the incoming XML stream and may be raised at any time. Importantly, these events may be handled in their own thread. @@ -148,8 +148,8 @@ when this bit of XML is received (with an assumed namespace of Raising XMPP Awareness: BaseXMPP -------------------------------- -While :class:`~sleekxmpp.xmlstream.xmlstream.XMLStream` attempts to shy away -from anything too XMPP specific, :class:`~sleekxmpp.basexmpp.BaseXMPP`'s +While :class:`~slixmpp.xmlstream.xmlstream.XMLStream` attempts to shy away +from anything too XMPP specific, :class:`~slixmpp.basexmpp.BaseXMPP`'s sole purpose is to provide foundational support for sending and receiving XMPP stanzas. This support includes registering the basic message, presence, and iq stanzas, methods for creating and sending stanzas, and @@ -157,14 +157,14 @@ default handlers for incoming messages and keeping track of presence notifications. The plugin system for adding new XEP support is also maintained by -:class:`~sleekxmpp.basexmpp.BaseXMPP`. +:class:`~slixmpp.basexmpp.BaseXMPP`. .. index:: ClientXMPP, BaseXMPP ClientXMPP ---------- -:class:`~sleekxmpp.clientxmpp.ClientXMPP` extends -:class:`~sleekxmpp.clientxmpp.BaseXMPP` with additional logic for connecting +:class:`~slixmpp.clientxmpp.ClientXMPP` extends +:class:`~slixmpp.clientxmpp.BaseXMPP` with additional logic for connecting to an XMPP server by performing DNS lookups. It also adds support for stream features such as STARTTLS and SASL. @@ -172,6 +172,6 @@ features such as STARTTLS and SASL. ComponentXMPP ------------- -:class:`~sleekxmpp.componentxmpp.ComponentXMPP` is only a thin layer on top of -:class:`~sleekxmpp.basexmpp.BaseXMPP` that implements the component handshake +:class:`~slixmpp.componentxmpp.ComponentXMPP` is only a thin layer on top of +:class:`~slixmpp.basexmpp.BaseXMPP` that implements the component handshake protocol. diff --git a/docs/conf.py b/docs/conf.py index 72e39d0f..fbb61b37 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# SleekXMPP documentation build configuration file, created by +# Slixmpp documentation build configuration file, created by # sphinx-quickstart on Tue Aug 9 22:27:06 2011. # # This file is execfile()d with the current directory set to its containing dir. @@ -40,7 +40,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'SleekXMPP' +project = u'Slixmpp' copyright = u'2011, Nathan Fritz, Lance Stout' # The version info for the project you're documenting, acts as replacement for @@ -105,7 +105,7 @@ html_theme = 'haiku' # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = 'SleekXMPP' +html_title = 'Slixmpp' # A shorter title for the navigation bar. Default is the same as html_title. html_short_title = '%s Documentation' % release @@ -168,7 +168,7 @@ html_additional_pages = { #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'SleekXMPPdoc' +htmlhelp_basename = 'Slixmppdoc' # -- Options for LaTeX output -------------------------------------------------- @@ -182,7 +182,7 @@ htmlhelp_basename = 'SleekXMPPdoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'SleekXMPP.tex', u'SleekXMPP Documentation', + ('index', 'Slixmpp.tex', u'Slixmpp Documentation', u'Nathan Fritz, Lance Stout', 'manual'), ] @@ -215,7 +215,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'sleekxmpp', u'SleekXMPP Documentation', + ('index', 'slixmpp', u'Slixmpp Documentation', [u'Nathan Fritz, Lance Stout'], 1) ] diff --git a/docs/create_plugin.rst b/docs/create_plugin.rst index 2b0514b8..7e082a7e 100644 --- a/docs/create_plugin.rst +++ b/docs/create_plugin.rst @@ -1,10 +1,10 @@ .. _create-plugin: -Creating a SleekXMPP Plugin +Creating a Slixmpp Plugin =========================== -One of the goals of SleekXMPP is to provide support for every draft or final -XMPP extension (`XEP `_). To do this, SleekXMPP has a +One of the goals of Slixmpp is to provide support for every draft or final +XMPP extension (`XEP `_). To do this, Slixmpp has a plugin mechanism for adding the functionalities required by each XEP. But even though plugins were made to quickly implement and prototype the official XMPP extensions, there is no reason you can't create your own plugin to implement @@ -14,11 +14,11 @@ This guide will help walk you through the steps to implement a rudimentary version of `XEP-0077 In-band Registration `_. In-band registration was implemented in example 14-6 (page 223) of `XMPP: The Definitive -Guide `_ because there was no SleekXMPP +Guide `_ because there was no Slixmpp plugin for XEP-0077 at the time of writing. We will partially fix that issue here by turning the example implementation from *XMPP: The Definitive Guide* into a plugin. Again, note that this will not a complete implementation, and a -different, more robust, official plugin for XEP-0077 may be added to SleekXMPP +different, more robust, official plugin for XEP-0077 may be added to Slixmpp in the future. .. note:: @@ -29,10 +29,10 @@ in the future. First Steps ----------- -Every plugin inherits from the class :mod:`base_plugin `, +Every plugin inherits from the class :mod:`base_plugin `, and must include a ``plugin_init`` method. While the -plugins distributed with SleekXMPP must be placed in the plugins directory -``sleekxmpp/plugins`` to be loaded, custom plugins may be loaded from any +plugins distributed with Slixmpp must be placed in the plugins directory +``slixmpp/plugins`` to be loaded, custom plugins may be loaded from any module. To do so, use the following form when registering the plugin: .. code-block:: python @@ -42,7 +42,7 @@ module. To do so, use the following form when registering the plugin: The plugin name must be the same as the plugin's class name. Now, we can open our favorite text editors and create ``xep_0077.py`` in -``SleekXMPP/sleekxmpp/plugins``. We want to do some basic house-keeping and +``Slixmpp/slixmpp/plugins``. We want to do some basic house-keeping and declare the name and description of the XEP we are implementing. If you are creating your own custom plugin, you don't need to include the ``xep`` attribute. @@ -50,13 +50,13 @@ attribute. .. code-block:: python """ - Creating a SleekXMPP Plugin + Creating a Slixmpp Plugin This is a minimal implementation of XEP-0077 to serve - as a tutorial for creating SleekXMPP plugins. + as a tutorial for creating Slixmpp plugins. """ - from sleekxmpp.plugins.base import base_plugin + from slixmpp.plugins.base import base_plugin class xep_0077(base_plugin): """ @@ -68,7 +68,7 @@ attribute. self.xep = "0077" Now that we have a basic plugin, we need to edit -``sleekxmpp/plugins/__init__.py`` to include our new plugin by adding +``slixmpp/plugins/__init__.py`` to include our new plugin by adding ``'xep_0077'`` to the ``__all__`` declaration. Interacting with Other Plugins @@ -83,12 +83,12 @@ finish activating the plugin. The ``post_init`` method needs to call ``base_plugin.post_init(self)`` which will mark that ``post_init`` has been called for the plugin. Once the -SleekXMPP object begins processing, ``post_init`` will be called on any plugins +Slixmpp object begins processing, ``post_init`` will be called on any plugins that have not already run ``post_init``. This allows you to register plugins and their dependencies without needing to worry about the order in which you do so. **Note:** by adding this call we have introduced a dependency on the XEP-0030 -plugin. Be sure to register ``'xep_0030'`` as well as ``'xep_0077'``. SleekXMPP +plugin. Be sure to register ``'xep_0030'`` as well as ``'xep_0077'``. Slixmpp does not automatically load plugin dependencies for you. .. code-block:: python @@ -141,7 +141,7 @@ behaviour: **Note:** The accessor methods currently use title case, and not camel case. Thus if you need to access an item named ``"methodName"`` you will need to use ``getMethodname``. This naming convention might change to full camel - case in a future version of SleekXMPP. + case in a future version of Slixmpp. * ``sub_interfaces`` A subset of ``interfaces``, but these keys map to the text of any @@ -156,8 +156,8 @@ behaviour: .. code-block:: python - from sleekxmpp.xmlstream import ElementBase, ET, JID, register_stanza_plugin - from sleekxmpp import Iq + from slixmpp.xmlstream import ElementBase, ET, JID, register_stanza_plugin + from slixmpp import Iq class Registration(ElementBase): namespace = 'jabber:iq:register' @@ -209,7 +209,7 @@ registration to our ``plugin_init`` method. Also, we need to associate our ``Registration`` class with IQ stanzas; that requires the use of the ``register_stanza_plugin`` function (in -``sleekxmpp.xmlstream.stanzabase``) which takes the class of a parent stanza +``slixmpp.xmlstream.stanzabase``) which takes the class of a parent stanza type followed by the substanza type. In our case, the parent stanza is an IQ stanza, and the substanza is our registration query. @@ -484,12 +484,12 @@ and that we specified the form fields we wish to use with .. code-block:: python - import sleekxmpp.componentxmpp + import slixmpp.componentxmpp - class Example(sleekxmpp.componentxmpp.ComponentXMPP): + class Example(slixmpp.componentxmpp.ComponentXMPP): def __init__(self, jid, password): - sleekxmpp.componentxmpp.ComponentXMPP.__init__(self, jid, password, 'localhost', 8888) + slixmpp.componentxmpp.ComponentXMPP.__init__(self, jid, password, 'localhost', 8888) self.registerPlugin('xep_0030') self.registerPlugin('xep_0077') @@ -517,17 +517,17 @@ with some additional registration fields implemented. .. code-block:: python """ - Creating a SleekXMPP Plugin + Creating a Slixmpp Plugin This is a minimal implementation of XEP-0077 to serve - as a tutorial for creating SleekXMPP plugins. + as a tutorial for creating Slixmpp plugins. """ - from sleekxmpp.plugins.base import base_plugin - from sleekxmpp.xmlstream.handler.callback import Callback - from sleekxmpp.xmlstream.matcher.xpath import MatchXPath - from sleekxmpp.xmlstream import ElementBase, ET, JID, register_stanza_plugin - from sleekxmpp import Iq + from slixmpp.plugins.base import base_plugin + from slixmpp.xmlstream.handler.callback import Callback + from slixmpp.xmlstream.matcher.xpath import MatchXPath + from slixmpp.xmlstream import ElementBase, ET, JID, register_stanza_plugin + from slixmpp import Iq import copy diff --git a/docs/event_index.rst b/docs/event_index.rst index ee8f5a95..b5f249f2 100644 --- a/docs/event_index.rst +++ b/docs/event_index.rst @@ -6,33 +6,33 @@ Event Index connected - **Data:** ``{}`` - - **Source:** :py:class:`~sleekxmpp.xmlstream.XMLstream` + - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream` Signal that a connection has been made with the XMPP server, but a session has not yet been established. connection_failed - **Data:** ``{}`` or ``Failure Stanza`` if available - - **Source:** :py:class:`~sleekxmpp.xmlstream.XMLstream` + - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream` Signal that a connection can not be established after number of attempts. changed_status - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.roster.item.RosterItem` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.roster.item.RosterItem` Triggered when a presence stanza is received from a JID with a show type different than the last presence stanza from the same JID. changed_subscription - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.BaseXMPP` Triggered whenever a presence stanza with a type of ``subscribe``, ``subscribed``, ``unsubscribe``, or ``unsubscribed`` is received. Note that if the values ``xmpp.auto_authorize`` and ``xmpp.auto_subscribe`` - are set to ``True`` or ``False``, and not ``None``, then SleekXMPP will + are set to ``True`` or ``False``, and not ``None``, then Slixmpp will either accept or reject all subscription requests before your event handlers are called. Set these values to ``None`` if you wish to make more complex subscription decisions. @@ -58,20 +58,20 @@ Event Index - **Source:** disco_info - - **Data:** :py:class:`~sleekxmpp.plugins.xep_0030.stanza.DiscoInfo` - - **Source:** :py:class:`~sleekxmpp.plugins.xep_0030.disco.xep_0030` + - **Data:** :py:class:`~slixmpp.plugins.xep_0030.stanza.DiscoInfo` + - **Source:** :py:class:`~slixmpp.plugins.xep_0030.disco.xep_0030` Triggered whenever a ``disco#info`` result stanza is received. disco_items - - **Data:** :py:class:`~sleekxmpp.plugins.xep_0030.stanza.DiscoItems` - - **Source:** :py:class:`~sleekxmpp.plugins.xep_0030.disco.xep_0030` + - **Data:** :py:class:`~slixmpp.plugins.xep_0030.stanza.DiscoItems` + - **Source:** :py:class:`~slixmpp.plugins.xep_0030.disco.xep_0030` Triggered whenever a ``disco#items`` result stanza is received. disconnected - **Data:** ``{}`` - - **Source:** :py:class:`~sleekxmpp.xmlstream.XMLstream` + - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream` Signal that the connection with the XMPP server has been lost. @@ -81,33 +81,33 @@ Event Index failed_auth - **Data:** ``{}`` - - **Source:** :py:class:`~sleekxmpp.ClientXMPP`, :py:class:`~sleekxmpp.plugins.xep_0078.xep_0078` + - **Source:** :py:class:`~slixmpp.ClientXMPP`, :py:class:`~slixmpp.plugins.xep_0078.xep_0078` Signal that the server has rejected the provided login credentials. gmail_notify - **Data:** ``{}`` - - **Source:** :py:class:`~sleekxmpp.plugins.gmail_notify.gmail_notify` + - **Source:** :py:class:`~slixmpp.plugins.gmail_notify.gmail_notify` Signal that there are unread emails for the Gmail account associated with the current XMPP account. gmail_messages - - **Data:** :py:class:`~sleekxmpp.Iq` - - **Source:** :py:class:`~sleekxmpp.plugins.gmail_notify.gmail_notify` + - **Data:** :py:class:`~slixmpp.Iq` + - **Source:** :py:class:`~slixmpp.plugins.gmail_notify.gmail_notify` Signal that there are unread emails for the Gmail account associated with the current XMPP account. got_online - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.roster.item.RosterItem` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.roster.item.RosterItem` If a presence stanza is received from a JID which was previously marked as offline, and the presence has a show type of '``chat``', '``dnd``', '``away``', or '``xa``', then this event is triggered as well. got_offline - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.roster.item.RosterItem` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.roster.item.RosterItem` Signal that an unavailable presence stanza has been received from a JID. @@ -116,24 +116,24 @@ Event Index - **Source:** groupchat_direct_invite - - **Data:** :py:class:`~sleekxmpp.Message` - - **Source:** :py:class:`~sleekxmpp.plugins.xep_0249.direct` + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0249.direct` groupchat_message - - **Data:** :py:class:`~sleekxmpp.Message` - - **Source:** :py:class:`~sleekxmpp.plugins.xep_0045.xep_0045` + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0045.xep_0045` Triggered whenever a message is received from a multi-user chat room. groupchat_presence - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.plugins.xep_0045.xep_0045` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.plugins.xep_0045.xep_0045` Triggered whenever a presence stanza is received from a user in a multi-user chat room. groupchat_subject - - **Data:** :py:class:`~sleekxmpp.Message` - - **Source:** :py:class:`~sleekxmpp.plugins.xep_0045.xep_0045` + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`~slixmpp.plugins.xep_0045.xep_0045` Triggered whenever the subject of a multi-user chat room is changed, or announced when joining a room. @@ -146,21 +146,21 @@ Event Index - **Source:** message - - **Data:** :py:class:`~sleekxmpp.Message` - - **Source:** :py:class:`BaseXMPP ` + - **Data:** :py:class:`~slixmpp.Message` + - **Source:** :py:class:`BaseXMPP ` Makes the contents of message stanzas available whenever one is received. Be sure to check the message type in order to handle error messages. message_form - - **Data:** :py:class:`~sleekxmpp.plugins.xep_0004.Form` - - **Source:** :py:class:`~sleekxmpp.plugins.xep_0004.xep_0004` + - **Data:** :py:class:`~slixmpp.plugins.xep_0004.Form` + - **Source:** :py:class:`~slixmpp.plugins.xep_0004.xep_0004` Currently the same as :term:`message_xform`. message_xform - - **Data:** :py:class:`~sleekxmpp.plugins.xep_0004.Form` - - **Source:** :py:class:`~sleekxmpp.plugins.xep_0004.xep_0004` + - **Data:** :py:class:`~slixmpp.plugins.xep_0004.Form` + - **Source:** :py:class:`~slixmpp.plugins.xep_0004.xep_0004` Triggered whenever a data form is received inside a message. @@ -181,74 +181,74 @@ Event Index - **Source:** presence_available - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.BaseXMPP` A presence stanza with a type of '``available``' is received. presence_error - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.BaseXMPP` A presence stanza with a type of '``error``' is received. presence_form - - **Data:** :py:class:`~sleekxmpp.plugins.xep_0004.Form` - - **Source:** :py:class:`~sleekxmpp.plugins.xep_0004.xep_0004` + - **Data:** :py:class:`~slixmpp.plugins.xep_0004.Form` + - **Source:** :py:class:`~slixmpp.plugins.xep_0004.xep_0004` This event is present in the XEP-0004 plugin code, but is currently not used. presence_probe - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.BaseXMPP` A presence stanza with a type of '``probe``' is received. presence_subscribe - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.BaseXMPP` A presence stanza with a type of '``subscribe``' is received. presence_subscribed - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.BaseXMPP` A presence stanza with a type of '``subscribed``' is received. presence_unavailable - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.BaseXMPP` A presence stanza with a type of '``unavailable``' is received. presence_unsubscribe - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.BaseXMPP` A presence stanza with a type of '``unsubscribe``' is received. presence_unsubscribed - - **Data:** :py:class:`~sleekxmpp.Presence` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.Presence` + - **Source:** :py:class:`~slixmpp.BaseXMPP` A presence stanza with a type of '``unsubscribed``' is received. roster_update - - **Data:** :py:class:`~sleekxmpp.stanza.Roster` - - **Source:** :py:class:`~sleekxmpp.ClientXMPP` + - **Data:** :py:class:`~slixmpp.stanza.Roster` + - **Source:** :py:class:`~slixmpp.ClientXMPP` An IQ result containing roster entries is received. sent_presence - **Data:** ``{}`` - - **Source:** :py:class:`~sleekxmpp.roster.multi.Roster` + - **Source:** :py:class:`~slixmpp.roster.multi.Roster` Signal that an initial presence stanza has been written to the XML stream. session_end - **Data:** ``{}`` - - **Source:** :py:class:`~sleekxmpp.xmlstream.XMLstream` + - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream` Signal that a connection to the XMPP server has been lost and the current stream session has ended. Currently equivalent to :term:`disconnected`, but @@ -260,16 +260,16 @@ Event Index session_start - **Data:** ``{}`` - - **Source:** :py:class:`ClientXMPP `, - :py:class:`ComponentXMPP ` - :py:class:`XEP-0078 ` + - **Source:** :py:class:`ClientXMPP `, + :py:class:`ComponentXMPP ` + :py:class:`XEP-0078 ` Signal that a connection to the XMPP server has been made and a session has been established. socket_error - **Data:** ``Socket`` exception object - - **Source:** :py:class:`~sleekxmpp.xmlstream.XMLstream` + - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream` stream_error - - **Data:** :py:class:`~sleekxmpp.stanza.StreamError` - - **Source:** :py:class:`~sleekxmpp.BaseXMPP` + - **Data:** :py:class:`~slixmpp.stanza.StreamError` + - **Source:** :py:class:`~slixmpp.BaseXMPP` diff --git a/docs/getting_started/component.rst b/docs/getting_started/component.rst index ce548ba4..efac7ad3 100644 --- a/docs/getting_started/component.rst +++ b/docs/getting_started/component.rst @@ -8,17 +8,17 @@ Create and Run a Server Component If you have any issues working through this quickstart guide or the other tutorials here, please either send a message to the - `mailing list `_ + `mailing list `_ or join the chat room at `sleek@conference.jabber.org `_. -If you have not yet installed SleekXMPP, do so now by either checking out a version -from `Github `_, or installing it using ``pip`` +If you have not yet installed Slixmpp, do so now by either checking out a version +from `Github `_, or installing it using ``pip`` or ``easy_install``. .. code-block:: sh - pip install sleekxmpp # Or: easy_install sleekxmpp + pip install slixmpp # Or: easy_install slixmpp Many XMPP applications eventually graduate to requiring to run as a server @@ -30,7 +30,7 @@ The first difference is that we will add an additional import statement: .. code-block:: python - from sleekxmpp.componentxmpp import ComponentXMPP + from slixmpp.componentxmpp import ComponentXMPP Likewise, we will change the bot's class definition to match: @@ -48,7 +48,7 @@ a MUC component, the following could be used: .. code-block:: python - muc = ComponentXMPP('muc.sleekxmpp.com', '******', 'sleekxmpp.com', 5555) + muc = ComponentXMPP('muc.slixmpp.com', '******', 'slixmpp.com', 5555) .. note:: @@ -62,10 +62,10 @@ with presence. The other, main difference with components is that the ``'from'`` value for every stanza must be explicitly set, since components may send stanzas from multiple JIDs. To do so, -the :meth:`~sleekxmpp.basexmpp.BaseXMPP.send_message()` and -:meth:`~sleekxmpp.basexmpp.BaseXMPP.send_presence()` accept the parameters +the :meth:`~slixmpp.basexmpp.BaseXMPP.send_message()` and +:meth:`~slixmpp.basexmpp.BaseXMPP.send_presence()` accept the parameters ``mfrom`` and ``pfrom``, respectively. For any method that uses -:class:`~sleekxmpp.stanza.iq.Iq` stanzas, ``ifrom`` may be used. +:class:`~slixmpp.stanza.iq.Iq` stanzas, ``ifrom`` may be used. Final Product diff --git a/docs/getting_started/echobot.rst b/docs/getting_started/echobot.rst index 7d29ec58..df5aa2b0 100644 --- a/docs/getting_started/echobot.rst +++ b/docs/getting_started/echobot.rst @@ -1,24 +1,24 @@ .. _echobot: =============================== -SleekXMPP Quickstart - Echo Bot +Slixmpp Quickstart - Echo Bot =============================== .. note:: If you have any issues working through this quickstart guide or the other tutorials here, please either send a message to the - `mailing list `_ + `mailing list `_ or join the chat room at `sleek@conference.jabber.org `_. -If you have not yet installed SleekXMPP, do so now by either checking out a version -from `Github `_, or installing it using ``pip`` +If you have not yet installed Slixmpp, do so now by either checking out a version +from `Github `_, or installing it using ``pip`` or ``easy_install``. .. code-block:: sh - pip install sleekxmpp # Or: easy_install sleekxmpp + pip install slixmpp # Or: easy_install slixmpp As a basic starting project, we will create an echo bot which will reply to any @@ -48,7 +48,7 @@ To get started, here is a brief outline of the structure that the final project import getpass from optparse import OptionParser - import sleekxmpp + import slixmpp '''Here we will create out echo bot class''' @@ -61,7 +61,7 @@ To get started, here is a brief outline of the structure that the final project Default Encoding ---------------- -XMPP requires support for UTF-8 and so SleekXMPP must use UTF-8 as well. In +XMPP requires support for UTF-8 and so Slixmpp must use UTF-8 as well. In Python3 this is simple because Unicode is the default string type. For Python2.6+ the situation is not as easy because standard strings are simply byte arrays and use ASCII. We can get Python to use UTF-8 as the default encoding by including: @@ -69,13 +69,13 @@ use ASCII. We can get Python to use UTF-8 as the default encoding by including: .. code-block:: python if sys.version_info < (3, 0): - from sleekxmpp.util.misc_ops import setdefaultencoding + from slixmpp.util.misc_ops import setdefaultencoding setdefaultencoding('utf8') .. warning:: - Until we are able to ensure that SleekXMPP will always use Unicode in Python2.6+, this - may cause issues embedding SleekXMPP into other applications which assume ASCII encoding. + Until we are able to ensure that Slixmpp will always use Unicode in Python2.6+, this + may cause issues embedding Slixmpp into other applications which assume ASCII encoding. Creating the EchoBot Class -------------------------- @@ -85,14 +85,14 @@ clients. Since our echo bot will only be responding to a few people, and won't n to remember thousands of users, we will use a client connection. A client connection is the same type that you use with your standard IM client such as Pidgin or Psi. -SleekXMPP comes with a :class:`ClientXMPP ` class -which we can extend to add our message echoing feature. :class:`ClientXMPP ` +Slixmpp comes with a :class:`ClientXMPP ` class +which we can extend to add our message echoing feature. :class:`ClientXMPP ` requires the parameters ``jid`` and ``password``, so we will let our ``EchoBot`` class accept those as well. .. code-block:: python - class EchoBot(sleekxmpp.ClientXMPP): + class EchoBot(slixmpp.ClientXMPP): def __init__(self, jid, password): super(EchoBot, self).__init__(jid, password) @@ -132,8 +132,8 @@ Our event handler, like every event handler, accepts a single parameter which ty that was received that caused the event. In this case, ``event`` will just be an empty dictionary since there is no associated data. -Our first task of sending an initial presence is done using :meth:`send_presence `. -Calling :meth:`send_presence ` without any arguments will send the simplest +Our first task of sending an initial presence is done using :meth:`send_presence `. +Calling :meth:`send_presence ` without any arguments will send the simplest stanza allowed in XMPP: .. code-block:: xml @@ -141,17 +141,17 @@ stanza allowed in XMPP: -The second requirement is fulfilled using :meth:`get_roster `, which +The second requirement is fulfilled using :meth:`get_roster `, which will send an IQ stanza requesting the roster to the server and then wait for the response. You may be wondering -what :meth:`get_roster ` returns since we are not saving any return +what :meth:`get_roster ` returns since we are not saving any return value. The roster data is saved by an internal handler to ``self.roster``, and in the case of a :class:`ClientXMPP -` instance to ``self.client_roster``. (The difference between ``self.roster`` and +` instance to ``self.client_roster``. (The difference between ``self.roster`` and ``self.client_roster`` is that ``self.roster`` supports storing roster information for multiple JIDs, which is useful for components, whereas ``self.client_roster`` stores roster data for just the client's JID.) It is possible for a timeout to occur while waiting for the server to respond, which can happen if the network is excessively slow or the server is no longer responding. In that case, an :class:`IQTimeout -` is raised. Similarly, an :class:`IQError ` exception can +` is raised. Similarly, an :class:`IQError ` exception can be raised if the request contained bad data or requested the roster for the wrong user. In either case, you can wrap the ``get_roster()`` call in a ``try``/``except`` block to retry the roster retrieval process. @@ -201,7 +201,7 @@ Let's take a closer look at the ``.reply()`` method used above. For message stan which is then used as the value of the ```` element of the message. Setting the appropriate ``to`` JID is also handled by ``.reply()``. -Another way to have sent the reply message would be to use :meth:`send_message `, +Another way to have sent the reply message would be to use :meth:`send_message `, which is a convenience method for generating and sending a message based on the values passed to it. If we were to use this method, the above code would look as so: @@ -229,13 +229,13 @@ Whichever method you choose to use, the results in action will look like this: XMPP does not require stanzas sent by a client to include a ``from`` attribute, and leaves that responsibility to the XMPP server. However, if a sent stanza does include a ``from`` attribute, it must match the full JID of the client or some - servers will reject it. SleekXMPP thus leaves out the ``from`` attribute when replying + servers will reject it. Slixmpp thus leaves out the ``from`` attribute when replying using a client connection. Command Line Arguments and Logging ---------------------------------- -While this isn't part of SleekXMPP itself, we do want our echo bot program to be able +While this isn't part of Slixmpp itself, we do want our echo bot program to be able to accept a JID and password from the command line instead of hard coding them. We will use the ``optparse`` module for this, though there are several alternative methods, including the newer ``argparse`` module. @@ -305,7 +305,7 @@ the ``EchoBot.__init__`` method instead. If you are using the OpenFire server, you will need to include an additional configuration step. OpenFire supports a different version of SSL than what - most servers and SleekXMPP support. + most servers and Slixmpp support. .. code-block:: python @@ -313,11 +313,11 @@ the ``EchoBot.__init__`` method instead. xmpp.ssl_version = ssl.PROTOCOL_SSLv3 Now we're ready to connect and begin echoing messages. If you have the package -``dnspython`` installed, then the :meth:`sleekxmpp.clientxmpp.ClientXMPP` method +``dnspython`` installed, then the :meth:`slixmpp.clientxmpp.ClientXMPP` method will perform a DNS query to find the appropriate server to connect to for the -given JID. If you do not have ``dnspython``, then SleekXMPP will attempt to +given JID. If you do not have ``dnspython``, then Slixmpp will attempt to connect to the hostname used by the JID, unless an address tuple is supplied -to :meth:`sleekxmpp.clientxmpp.ClientXMPP`. +to :meth:`slixmpp.clientxmpp.ClientXMPP`. .. code-block:: python @@ -346,19 +346,19 @@ to :meth:`sleekxmpp.clientxmpp.ClientXMPP`. else: print('Unable to connect') -To begin responding to messages, you'll see we called :meth:`sleekxmpp.basexmpp.BaseXMPP.process` +To begin responding to messages, you'll see we called :meth:`slixmpp.basexmpp.BaseXMPP.process` which will start the event handling, send queue, and XML reader threads. It will also call -the :meth:`sleekxmpp.plugins.base.base_plugin.post_init` method on all registered plugins. By -passing ``block=True`` to :meth:`sleekxmpp.basexmpp.BaseXMPP.process` we are running the -main processing loop in the main thread of execution. The :meth:`sleekxmpp.basexmpp.BaseXMPP.process` -call will not return until after SleekXMPP disconnects. If you need to run the client in the background +the :meth:`slixmpp.plugins.base.base_plugin.post_init` method on all registered plugins. By +passing ``block=True`` to :meth:`slixmpp.basexmpp.BaseXMPP.process` we are running the +main processing loop in the main thread of execution. The :meth:`slixmpp.basexmpp.BaseXMPP.process` +call will not return until after Slixmpp disconnects. If you need to run the client in the background for another program, use ``block=False`` to spawn the processing loop in its own thread. .. note:: - Before 1.0, controlling the blocking behaviour of :meth:`sleekxmpp.basexmpp.BaseXMPP.process` was + Before 1.0, controlling the blocking behaviour of :meth:`slixmpp.basexmpp.BaseXMPP.process` was done via the ``threaded`` argument. This arrangement was a source of confusion because some users - interpreted that as controlling whether or not SleekXMPP used threads at all, instead of how + interpreted that as controlling whether or not Slixmpp used threads at all, instead of how the processing loop itself was spawned. The statements ``xmpp.process(threaded=False)`` and ``xmpp.process(block=True)`` are equivalent. @@ -370,7 +370,7 @@ The Final Product ----------------- Here then is what the final result should look like after working through the guide above. The code -can also be found in the SleekXMPP `examples directory `_. +can also be found in the Slixmpp `examples directory `_. .. compound:: diff --git a/docs/getting_started/iq.rst b/docs/getting_started/iq.rst index 98e0bdaf..cbf3d476 100644 --- a/docs/getting_started/iq.rst +++ b/docs/getting_started/iq.rst @@ -1,17 +1,17 @@ Send/Receive IQ Stanzas ======================= -Unlike :class:`~sleekxmpp.stanza.message.Message` and -:class:`~sleekxmpp.stanza.presence.Presence` stanzas which only use -text data for basic usage, :class:`~sleekxmpp.stanza.iq.Iq` stanzas +Unlike :class:`~slixmpp.stanza.message.Message` and +:class:`~slixmpp.stanza.presence.Presence` stanzas which only use +text data for basic usage, :class:`~slixmpp.stanza.iq.Iq` stanzas require using XML payloads, and generally entail creating a new -SleekXMPP plugin to provide the necessary convenience methods to +Slixmpp plugin to provide the necessary convenience methods to make working with them easier. Basic Use --------- -XMPP's use of :class:`~sleekxmpp.stanza.iq.Iq` stanzas is built around +XMPP's use of :class:`~slixmpp.stanza.iq.Iq` stanzas is built around namespaced ```` elements. For clients, just sending the empty ```` element will suffice for retrieving information. For example, a very basic implementation of service discovery would just @@ -26,18 +26,18 @@ need to be able to send: Creating Iq Stanzas ~~~~~~~~~~~~~~~~~~~ -SleekXMPP provides built-in support for creating basic :class:`~sleekxmpp.stanza.iq.Iq` +Slixmpp provides built-in support for creating basic :class:`~slixmpp.stanza.iq.Iq` stanzas this way. The relevant methods are: -* :meth:`~sleekxmpp.basexmpp.BaseXMPP.make_iq` -* :meth:`~sleekxmpp.basexmpp.BaseXMPP.make_iq_get` -* :meth:`~sleekxmpp.basexmpp.BaseXMPP.make_iq_set` -* :meth:`~sleekxmpp.basexmpp.BaseXMPP.make_iq_result` -* :meth:`~sleekxmpp.basexmpp.BaseXMPP.make_iq_error` -* :meth:`~sleekxmpp.basexmpp.BaseXMPP.make_iq_query` +* :meth:`~slixmpp.basexmpp.BaseXMPP.make_iq` +* :meth:`~slixmpp.basexmpp.BaseXMPP.make_iq_get` +* :meth:`~slixmpp.basexmpp.BaseXMPP.make_iq_set` +* :meth:`~slixmpp.basexmpp.BaseXMPP.make_iq_result` +* :meth:`~slixmpp.basexmpp.BaseXMPP.make_iq_error` +* :meth:`~slixmpp.basexmpp.BaseXMPP.make_iq_query` These methods all follow the same pattern: create or modify an existing -:class:`~sleekxmpp.stanza.iq.Iq` stanza, set the ``'type'`` value based +:class:`~slixmpp.stanza.iq.Iq` stanza, set the ``'type'`` value based on the method name, and finally add a ```` element with the given namespace. For example, to produce the query above, you would use: @@ -50,14 +50,14 @@ namespace. For example, to produce the query above, you would use: Sending Iq Stanzas ~~~~~~~~~~~~~~~~~~ -Once an :class:`~sleekxmpp.stanza.iq.Iq` stanza is created, sending it -over the wire is done using its :meth:`~sleekxmpp.stanza.iq.Iq.send()` +Once an :class:`~slixmpp.stanza.iq.Iq` stanza is created, sending it +over the wire is done using its :meth:`~slixmpp.stanza.iq.Iq.send()` method, like any other stanza object. However, there are a few extra options to control how to wait for the query's response. These options are: -* ``block``: The default behaviour is that :meth:`~sleekxmpp.stanza.iq.Iq.send()` +* ``block``: The default behaviour is that :meth:`~slixmpp.stanza.iq.Iq.send()` will block until a response is received and the response stanza will be the return value. Setting ``block`` to ``False`` will cause the call to return immediately. In which case, you will need to arrange some way to capture @@ -90,11 +90,11 @@ These options are: # ... later if we need to cancel self.remove_handler(cb_name) -Properly working with :class:`~sleekxmpp.stanza.iq.Iq` stanzas requires +Properly working with :class:`~slixmpp.stanza.iq.Iq` stanzas requires handling the intended, normal flow, error responses, and timed out requests. To make this easier, two exceptions may be thrown by -:meth:`~sleekxmpp.stanza.iq.Iq.send()`: :exc:`~sleekxmpp.exceptions.IqError` -and :exc:`~sleekxmpp.exceptions.IqTimeout`. These exceptions only +:meth:`~slixmpp.stanza.iq.Iq.send()`: :exc:`~slixmpp.exceptions.IqError` +and :exc:`~slixmpp.exceptions.IqTimeout`. These exceptions only apply to the default, blocking calls. .. code-block:: python @@ -110,7 +110,7 @@ apply to the default, blocking calls. pass If you do not care to distinguish between errors and timeouts, then you -can combine both cases with a generic :exc:`~sleekxmpp.exceptions.XMPPError` +can combine both cases with a generic :exc:`~slixmpp.exceptions.XMPPError` exception: .. code-block:: python @@ -124,9 +124,9 @@ exception: Advanced Use ------------ -Going beyond the basics provided by SleekXMPP requires building at least a -rudimentary SleekXMPP plugin to create a :term:`stanza object` for -interfacting with the :class:`~sleekxmpp.stanza.iq.Iq` payload. +Going beyond the basics provided by Slixmpp requires building at least a +rudimentary Slixmpp plugin to create a :term:`stanza object` for +interfacting with the :class:`~slixmpp.stanza.iq.Iq` payload. .. seealso:: @@ -135,13 +135,13 @@ interfacting with the :class:`~sleekxmpp.stanza.iq.Iq` payload. * :ref:`using-handlers-matchers` -The typical way to respond to :class:`~sleekxmpp.stanza.iq.Iq` requests is +The typical way to respond to :class:`~slixmpp.stanza.iq.Iq` requests is to register stream handlers. As an example, suppose we create a stanza class named ``CustomXEP`` which uses the XML element ````, -and has a :attr:`~sleekxmpp.xmlstream.stanzabase.ElementBase.plugin_attrib` value +and has a :attr:`~slixmpp.xmlstream.stanzabase.ElementBase.plugin_attrib` value of ``custom_xep``. -There are two types of incoming :class:`~sleekxmpp.stanza.iq.Iq` requests: +There are two types of incoming :class:`~slixmpp.stanza.iq.Iq` requests: ``get`` and ``set``. You can register a handler that will accept both and then filter by type as needed, as so: @@ -167,7 +167,7 @@ filter by type as needed, as so: If you want to filter out query types beforehand, you can adjust the matching filter by using ``@type=get`` or ``@type=set`` if you are using the recommended -:class:`~sleekxmpp.xmlstream.matcher.stanzapath.StanzaPath` matcher. +:class:`~slixmpp.xmlstream.matcher.stanzapath.StanzaPath` matcher. .. code-block:: python diff --git a/docs/getting_started/muc.rst b/docs/getting_started/muc.rst index 26e1fa57..8e41790f 100644 --- a/docs/getting_started/muc.rst +++ b/docs/getting_started/muc.rst @@ -8,20 +8,20 @@ Mulit-User Chat (MUC) Bot If you have any issues working through this quickstart guide or the other tutorials here, please either send a message to the - `mailing list `_ + `mailing list `_ or join the chat room at `sleek@conference.jabber.org `_. -If you have not yet installed SleekXMPP, do so now by either checking out a version -from `Github `_, or installing it using ``pip`` +If you have not yet installed Slixmpp, do so now by either checking out a version +from `Github `_, or installing it using ``pip`` or ``easy_install``. .. code-block:: sh - pip install sleekxmpp # Or: easy_install sleekxmpp + pip install slixmpp # Or: easy_install slixmpp -Now that you've got the basic gist of using SleekXMPP by following the +Now that you've got the basic gist of using Slixmpp by following the echobot example (:ref:`echobot`), we can use one of the bundled plugins to create a very popular XMPP starter project: a `Multi-User Chat`_ (MUC) bot. Our bot will login to an XMPP server, join an MUC chat room @@ -36,7 +36,7 @@ Joining The Room As usual, our code will be based on the pattern explained in :ref:`echobot`. To start, we create an ``MUCBot`` class based on -:class:`ClientXMPP ` and which accepts +:class:`ClientXMPP ` and which accepts parameters for the JID of the MUC room to join, and the nick that the bot will use inside the chat room. We also register an :term:`event handler` for the :term:`session_start` event. @@ -44,12 +44,12 @@ bot will use inside the chat room. We also register an .. code-block:: python - import sleekxmpp + import slixmpp - class MUCBot(sleekxmpp.ClientXMPP): + class MUCBot(slixmpp.ClientXMPP): def __init__(self, jid, password, room, nick): - sleekxmpp.ClientXMPP.__init__(self, jid, password) + slixmpp.ClientXMPP.__init__(self, jid, password) self.room = room self.nick = nick @@ -81,7 +81,7 @@ the roster. Next, we want to join the group chat, so we call the .. note:: - The :attr:`plugin ` attribute is + The :attr:`plugin ` attribute is dictionary that maps to instances of plugins that we have previously registered, by their names. @@ -115,7 +115,7 @@ event inside the bot's ``__init__`` function. .. code-block:: python def __init__(self, jid, password, room, nick): - sleekxmpp.ClientXMPP.__init__(self, jid, password) + slixmpp.ClientXMPP.__init__(self, jid, password) self.room = room self.nick = nick @@ -159,7 +159,7 @@ event so it's a good idea to register an event handler for it. .. code-block:: python def __init__(self, jid, password, room, nick): - sleekxmpp.ClientXMPP.__init__(self, jid, password) + slixmpp.ClientXMPP.__init__(self, jid, password) self.room = room self.nick = nick diff --git a/docs/getting_started/proxy.rst b/docs/getting_started/proxy.rst index 60d521c5..b5e74180 100644 --- a/docs/getting_started/proxy.rst +++ b/docs/getting_started/proxy.rst @@ -8,16 +8,16 @@ Enable HTTP Proxy Support If you have any issues working through this quickstart guide or the other tutorials here, please either send a message to the - `mailing list `_ + `mailing list `_ or join the chat room at `sleek@conference.jabber.org `_. In some instances, you may wish to route XMPP traffic through an HTTP proxy, probably to get around restrictive firewalls. -SleekXMPP provides support for basic HTTP proxying with DIGEST +Slixmpp provides support for basic HTTP proxying with DIGEST authentication. -Enabling proxy support is done in two steps. The first is to instruct SleekXMPP +Enabling proxy support is done in two steps. The first is to instruct Slixmpp to use a proxy, and the second is to configure the proxy details: .. code-block:: python diff --git a/docs/getting_started/sendlogout.rst b/docs/getting_started/sendlogout.rst index a1352db9..5b23a469 100644 --- a/docs/getting_started/sendlogout.rst +++ b/docs/getting_started/sendlogout.rst @@ -5,25 +5,25 @@ Sign in, Send a Message, and Disconnect If you have any issues working through this quickstart guide or the other tutorials here, please either send a message to the - `mailing list `_ + `mailing list `_ or join the chat room at `sleek@conference.jabber.org `_. -A common use case for SleekXMPP is to send one-off messages from +A common use case for Slixmpp is to send one-off messages from time to time. For example, one use case could be sending out a notice when a shell script finishes a task. We will create our one-shot bot based on the pattern explained in :ref:`echobot`. To -start, we create a client class based on :class:`ClientXMPP ` and +start, we create a client class based on :class:`ClientXMPP ` and register a handler for the :term:`session_start` event. We will also accept parameters for the JID that will receive our message, and the string content of the message. .. code-block:: python - import sleekxmpp + import slixmpp - class SendMsgBot(sleekxmpp.ClientXMPP): + class SendMsgBot(slixmpp.ClientXMPP): def __init__(self, jid, password, recipient, msg): super(SendMsgBot, self).__init__(jid, password) @@ -38,7 +38,7 @@ for the JID that will receive our message, and the string content of the message self.get_roster() Note that as in :ref:`echobot`, we need to include send an initial presence and request -the roster. Next, we want to send our message, and to do that we will use :meth:`send_message `. +the roster. Next, we want to send our message, and to do that we will use :meth:`send_message `. .. code-block:: python @@ -48,12 +48,12 @@ the roster. Next, we want to send our message, and to do that we will use :meth: self.send_message(mto=self.recipient, mbody=self.msg) -Finally, we need to disconnect the client using :meth:`disconnect `. +Finally, we need to disconnect the client using :meth:`disconnect `. Now, sent stanzas are placed in a queue to pass them to the send thread. If we were to call -:meth:`disconnect ` without any parameters, then it is possible +:meth:`disconnect ` without any parameters, then it is possible for the client to disconnect before the send queue is processed and the message is actually sent on the wire. To ensure that our message is processed, we use -:meth:`disconnect(wait=True) `. +:meth:`disconnect(wait=True) `. .. code-block:: python @@ -68,7 +68,7 @@ sent on the wire. To ensure that our message is processed, we use .. warning:: If you happen to be adding stanzas to the send queue faster than the send thread - can process them, then :meth:`disconnect(wait=True) ` + can process them, then :meth:`disconnect(wait=True) ` will block and not disconnect. Final Product diff --git a/docs/guide_xep_0030.rst b/docs/guide_xep_0030.rst index cb8d7d25..cd0f4850 100644 --- a/docs/guide_xep_0030.rst +++ b/docs/guide_xep_0030.rst @@ -18,7 +18,7 @@ Working with service discovery is about creating and querying these nodes. According to XEP-0030, a node may contain three types of information: identities, features, and items. (Further, extensible, information types are defined in `XEP-0128 `_, but they are -not yet implemented by SleekXMPP.) SleekXMPP provides methods to configure each +not yet implemented by Slixmpp.) Slixmpp provides methods to configure each of these node attributes. Configuring Service Discovery @@ -119,7 +119,7 @@ the same order as expected using positional arguments. xmpp['xep_0030'].add_identity(category='client', itype='bot', - name='Sleek', + name='Slixmpp', node='foo', jid=xmpp.boundjid.full, lang='no') diff --git a/docs/index.rst b/docs/index.rst index 6f6d8913..33d6cd00 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,49 +1,49 @@ -SleekXMPP +Slixmpp ######### .. sidebar:: Get the Code .. code-block:: sh - pip install sleekxmpp + pip install slixmpp - The latest source code for SleekXMPP may be found on `Github - `_. Releases can be found in the + The latest source code for Slixmpp may be found on `Github + `_. Releases can be found in the ``master`` branch, while the latest development version is in the ``develop`` branch. **Latest Stable Release** - - `1.0 `_ + - `1.0 `_ **Develop Releases** - - `Latest Develop Version `_ + - `Latest Develop Version `_ A mailing list and XMPP chat room are available for discussing and getting - help with SleekXMPP. + help with Slixmpp. **Mailing List** - `SleekXMPP Discussion on Google Groups `_ + `Slixmpp Discussion on Google Groups `_ **Chat** `sleek@conference.jabber.org `_ -SleekXMPP is an :ref:`MIT licensed ` XMPP library for Python 2.6/3.1+, +Slixmpp is an :ref:`MIT licensed ` XMPP library for Python 2.6/3.1+, and is featured in examples in `XMPP: The Definitive Guide `_ by Kevin Smith, Remko Tronçon, and Peter Saint-Andre. If you've arrived here from reading the Definitive Guide, please see the notes on updating -the examples to the latest version of SleekXMPP. +the examples to the latest version of Slixmpp. -SleekXMPP's design goals and philosphy are: +Slixmpp's design goals and philosphy are: **Low number of dependencies** - Installing and using SleekXMPP should be as simple as possible, without + Installing and using Slixmpp should be as simple as possible, without having to deal with long dependency chains. As part of reducing the number of dependencies, some third party - modules are included with SleekXMPP in the ``thirdparty`` directory. + modules are included with Slixmpp in the ``thirdparty`` directory. Imports from this module first try to import an existing installed version before loading the packaged version, when possible. @@ -55,19 +55,19 @@ SleekXMPP's design goals and philosphy are: XEPs. **Rewarding to work with** - As much as possible, SleekXMPP should allow things to "just work" using + As much as possible, Slixmpp should allow things to "just work" using sensible defaults and appropriate abstractions. XML can be ugly to work with, but it doesn't have to be that way. -Here's your first SleekXMPP Bot: +Here's your first Slixmpp Bot: -------------------------------- .. code-block:: python import logging - from sleekxmpp import ClientXMPP - from sleekxmpp.exceptions import IqError, IqTimeout + from slixmpp import ClientXMPP + from slixmpp.exceptions import IqError, IqTimeout class EchoBot(ClientXMPP): @@ -161,7 +161,7 @@ Plugin Guides guide_xep_0030 -SleekXMPP Architecture and Design +Slixmpp Architecture and Design --------------------------------- .. toctree:: :maxdepth: 3 diff --git a/docs/make.bat b/docs/make.bat index d97407a6..33fda62b 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -95,9 +95,9 @@ if "%1" == "qthelp" ( echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\SleekXMPP.qhcp + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Slixmpp.qhcp echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\SleekXMPP.ghc + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Slixmpp.ghc goto end ) diff --git a/docs/xmpp_tdg.rst b/docs/xmpp_tdg.rst index 3d12b1b6..c0d85196 100644 --- a/docs/xmpp_tdg.rst +++ b/docs/xmpp_tdg.rst @@ -1,20 +1,20 @@ Following *XMPP: The Definitive Guide* ====================================== -SleekXMPP was featured in the first edition of the O'Reilly book +Slixmpp was featured in the first edition of the O'Reilly book `XMPP: The Definitive Guide `_ by Peter Saint-Andre, Kevin Smith, and Remko Tronçon. The original source code for the book's examples can be found at http://github.com/remko/xmpp-tdg. An updated version of the source code, maintained to stay current with the latest -SleekXMPP release, is available at http://github.com/legastero/xmpp-tdg. +Slixmpp release, is available at http://github.com/legastero/xmpp-tdg. -However, since publication, SleekXMPP has advanced from version 0.2.1 to version +However, since publication, Slixmpp has advanced from version 0.2.1 to version 1.0 and there have been several major API changes. The most notable is the introduction of :term:`stanza objects ` which have simplified and standardized interactions with the XMPP XML stream. What follows is a walk-through of *The Definitive Guide* highlighting the -changes needed to make the code examples work with version 1.0 of SleekXMPP. +changes needed to make the code examples work with version 1.0 of Slixmpp. These changes have been kept to a minimum to preserve the correlation with the book's explanations, so be aware that some code may not use current best practices. @@ -47,7 +47,7 @@ Example 14-1. (Page 215) **CheshiR IM bot implementation.** The main event handling method in the Bot class is meant to process both message -events and presence update events. With the new changes in SleekXMPP 1.0, +events and presence update events. With the new changes in Slixmpp 1.0, extracting a CheshiR status "message" from both types of stanzas requires accessing different attributes. In the case of a message stanza, the ``"body"`` attribute would contain the CheshiR message. For a presence event, @@ -72,8 +72,8 @@ Updated Code .. code-block:: python def handleIncomingXMPPEvent(self, event): - msgLocations = {sleekxmpp.stanza.presence.Presence: "status", - sleekxmpp.stanza.message.Message: "body"} + msgLocations = {slixmpp.stanza.presence.Presence: "status", + slixmpp.stanza.message.Message: "body"} message = event[msgLocations[type(event)]] user = self.backend.getUserFromJID(event["from"].jid) @@ -102,7 +102,7 @@ Example 14-3. (Page 217) The main difference for the configurable IM bot is the handling for the data form in ``handleConfigurationCommand``. The test for equality -with the string ``"1"`` is no longer required; SleekXMPP converts +with the string ``"1"`` is no longer required; Slixmpp converts boolean data form fields to the values ``True`` and ``False`` automatically. @@ -192,7 +192,7 @@ After applying the changes from Example 14-4 above, the registrable component implementation should work correctly. .. tip:: - To see how to implement in-band registration as a SleekXMPP plugin, + To see how to implement in-band registration as a Slixmpp plugin, see the tutorial :ref:`tutorial-create-plugin`. `View full source `_ | @@ -209,7 +209,7 @@ Example 14-7. (Page 225) While the final code example can look daunting with all of the changes made, it requires very few modifications to work with the latest version of -SleekXMPP. Most differences are the result of CheshiR's backend functions +Slixmpp. Most differences are the result of CheshiR's backend functions expecting JIDs to be strings so that they can be stripped to bare JIDs. To resolve these, use the ``jid`` attribute of the JID objects. Also, references to ``"message"`` and ``"jid"`` attributes need to -- cgit v1.2.3