SIP SIMPLE Client SDK

[[Image(htdocs:SIPUA-design-70.png, align=right, link=wiki:SIPUADesign)]]

== Project description == 

PyPjUA is Python software library for [http://pjsip.org PJSIP] C SIP stack that together with an elegant middleware allows for easy development of real-time Internet communications end-points based on [http://tools.ietf.org/html/rfc3261 SIP protocol] with rich presence and IM capability for computers running Mac OS X, Linux and Windows operating systems or portable devices like Nokia Internet tablet, Apple iPhone and Android mobile phone.

== Deliverables ==

The goal of this project is to deliver the best Open Source development kit for rich featured SIP User Agents, while hiding the complex underlying functionality behind an easy to use high-level application programming interface. Compared to other available SIP libraries, this project adds session based Interactive Messaging (IM) using MSRP protocol, multiple media streams support, 'the missing' SIP-SIMPLE features for rich presence (presence rules, resource lists, rls services, rich PIDF, XCAP full and partial document manipulation).

The software library is tested against the most popular SIP server software available today: [http://opensips.org OpenSER], [http://openxcap.org OpenXCAP], [http://msrprelay.org MSRPRelay] and [http://mediaproxy-ng.org MediaProxy]. 

== Download  == 

The software library and command line tools will be available for download on 2008 Q4 from: 

[http://download.ag-projects.com/PyPjUA http://download.ag-projects.com/PyPjUA]

== End-user experiences ==

This software allows you to create elegant real-time communications applications without having to read [http://www.rfc3261.net the +1200 RFC documents] behind it. 

''If you read them all, some antidepressant and desintoxication is recommended after this effort.'' 

As a library with a high-level API, the toolkit can also be used to add SIP and Presence functionality to network devices without a display (like TV set-up boxes), as long as Python environment is supported by such platform. You may collapse the whole telecom industry into a simple ''Call me'' button or expand the presence buddy list to display the mood or blood pressure of your buddies (if they want to share this information with you). Some of the things possible with this library are listed here:

  * VoIP calls using Internet codecs (wide-band Speex, iLBC) and G.711

  * Zero configuration server-less communication over LAN (Bonjour)

  * Presence using SIP SIMPLE (PUBLISH, SUBSCRIBE, NOTIFY and XCAP policy)

  * Interactive Messaging (IM) and File transfer using MSRP protocol

  * Multiparty chat using MSRP chat server

  * Support for NAT traversal using ICE and MediaProxy for RTP media and MSRP relay for IM and file transfer

  * Sharing desktop screens using VNC protocol (under construction)

  * Video calls (under construction)

== Testing the library ==

Besides the Python software library itself, the repository contains ready to use command-line examples scripts for Linux and MacOSX that can be used to:

  * Setup IM or file-transfer ([http://tools.ietf.org/html/rfc4975 MSRP sessions]) with or without support from a [http://tools.ietf.org/html/rfc4976 MSRP relay]

  * Setup up VoIP sessions using speex wide-band codec

  * [http://tools.ietf.org/html/rfc3903 PUBLISH], SUBSCRIBE and handle incoming NOTIFY for [http://tools.ietf.org/html/rfc3265 SIP events] [http://tools.ietf.org/html/rfc3856 presence], [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt xcap-diff], [http://tools.ietf.org/html/rfc3857 watcher-info], [http://tools.ietf.org/html/rfc4575 conference], [http://tools.ietf.org/html/rfc3842 message-summary]

  * Manage [http://www.tools.ietf.org/html/rfc4825 XCAP] documents [http://www.tools.ietf.org/html/rfc5025 pres-rules], [http://www.tools.ietf.org/html/rfc4826 resource-lists, rls-services] and [http://www.tools.ietf.org/html/rfc4827 pidf-manipulation]

  * Lookup of SIP buddies using [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt Bonjour] (LAN broadcast), [http://tools.ietf.org/html/rfc3263 RFC 3263] (Locating SIP Services)

  * Setup up [http://tools.ietf.org/html/draft-ietf-simple-chat-02 ad-hoc multi-party chat sessions] with an MSRP chat server (under construction)

For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]

== License == 

The software is provided under the [source:LICENSE GPL LICENSE]

== Contributing ==

If you wish to become an active developer of this project, send your request by email to [mailto:pypjua-devel@ag-projects.com pypjua-devel@ag-projects.com].

We are looking for developers that can contribute with the following features: VNC desktop sharing, implementation for video sessions and real time text sessions (real time text using RTP [http://www.ietf.org/rfc/rfc4103.txt ToIP (RFC 4103)] and MSRP).