= Wokkel =

Wokkel is collection of enhancements on top of the [http://www.twistedmatrix.com/ Twisted] networking framework, written in Python. It mostly provides a testing ground for enhancements to the Jabber/XMPP protocol implementation as found in Twisted Words, that are meant to eventually move there.

'''[/documentation/current/ Start here]''' with the developer guides for Wokkel, including [/documentation/current/examples/ examples] and the current [/documentation/current/api/ API reference].

Currently, Wokkel provides the following enhancements on top of Twisted Words:

 * A mechanism for easier implementation of [http://www.xmpp.org/extensions/ XMPP Extension Protocols] (XEPs) as so-called ''subprotocols''.
 * XMPP Client and server-side component support, that eases development and supports subprotocols.
 * XMPP Server support. Note that this does not yet include support for handling client connections.
 * Subprotocol implementations for:
   * Generic presence, roster and message handling.
   * Service Discovery ([XEP:0030 XEP-0030]), client and service side.
   * Publish-Subscribe ([XEP:0060 XEP-0060]), client and service side.
   * Software Version ([XEP:0092 XEP-0092]), service side.
   * XMPP Ping ([XEP:0199 XEP-0199]), client and service side.
   * Multi-User Chat ([XEP:0045 XEP-0045]), client side. (''new in 0.7.0'')
 * Data format implementations for:
   * Data Forms ([XEP:0004 XEP-0004])
   * User Tune ([XEP:0118 XEP-0118])
   * User Mood ([XEP:0107 XEP-0107])
   * XMPP Stanza Headers and Internet Metadata. ([XEP:0131 XEP-0131]).
   * Delayed Delivery ([XEP:0203 XEP-0203] and [XEP:0091 XEP-0091]). (''new in 0.7.0'')



 
= Downloads =

Available via the [/downloads downloads section]:

 * Latest stable release: '''[http://wokkel.ik.nu/releases/0.7.1/wokkel-0.7.1.tar.gz 0.7.1]''' (2013-01-12).

= Discussion =

Your input is much appreciated. The [https://mailman.ik.nu/mailman/listinfo/twisted-jabber Twisted Jabber mailing list] is home to user questions, announcements and development discussions.

If you want an account for this Trac instance, contact me. I disabled online registration due to spam.

= Development =

== Main repository ==

The main Mercurial repository is available at [http://hg.ik.nu/wokkel]. Quick checkout:
  
  `hg clone http://hg.ik.nu/wokkel`

Clones:

 * [http://github.com/ralphm/wokkel Wokkel GIT clone at GitHub]
 * [http://bitbucket.org/ralphm/wokkel Wokkel Mercurial clone at Bitbucket]

== Work in progress ==

Some work-in-progress by ralphm is in Mercurial Queues and feature clones at [http://hg.ik.nu/ralphm].

Clones:
 * [http://bitbucket.org/ralphm/wokkel-patches Wokkel Mercurial Patch Queue at BitBucket] 

== Subversion ==

Note that the old Subversion repository (https://svn.ik.nu/wokkel/) is current up till the 0.6.3 release, and is '''no longer updated'''.

= Name =

Wokkel lends it name from a popular twisted savory snack in the Netherlands.

= Author =

Wokkel's primary author is [xmpp:ralphm@ik.nu Ralph Meijer]. In his [http://ralphm.net/blog/ personal blog], Ralph posts the latest developments on Wokkel and other Jabber related topics.