SIP SIMPLE Client SDK

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

== Project description == 

PyPjUA is Python software library for [http://pjsip.org PJSIP] C SIP stack that together with a clever middleware allows for easy development of real-time communications end-points based on [http://tools.ietf.org/html/rfc3261 SIP protocol] with rich presence and IM capability that run on desktop computers running Mac OS X, Linux and Windows operating systems, portable devices like Nokia Internet tablet, Apple iPhone or 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 'the missing' SIP-SIMPLE features for rich presence (RLS-services, XCAP-diff, R-PIDF, XCAP) and session based interactive messaging based on MSRP. 

== End-user experiences ==

Using this software you are able to create elegant real-time communications applications without having to read or understand [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).   

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

  * Multiple RTP streams per session (for live broadcasting applications)

  * Session based IM with voice/video for rich end-to-end communications

  * Zero configuration when communicating 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 for RTP media and MSRP relay for IM and file transfer

  * Sharing desktop screen using VNC protocol

  * Video calls

The software library has been tested against the most popular SIP server software: [http://openser.org OpenSER], [http://openxcap.org OpenXCAP], [http://mediaproxy-ng.org MediaProxy] and [http://msrprelay.org MSRPRelay] servers. To test the software you can register a free SIP SIMPLE account on [http://SIP2SIP.info SIP2SIP]

== High level design ==

PyPjUA is part of a [wiki:SIPUADesign greater design] design to provide a fully fledged SIP UA. 

== Software repository ==

Besides the Python software library itself, the repository contains the ready to use sip-simple-test-tools package that can be used to:

  * Setup SIP [http://tools.ietf.org/html/rfc4975 MSRP sessions] between end-points with public IP or behind NAT by using [http://tools.ietf.org/html/rfc4976 MSRP relay]

  * Setup up VoIP sessions between end-points with public IP adresses or behind NAT by using ICE or MediaProxy

  * [http://tools.ietf.org/html/rfc3903 PUBLISH] and [http://tools.ietf.org/html/rfc3265 SUBSCRIBE/NOTIFY to SIP events] like [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 presence policy the form of full or partial [http://www.tools.ietf.org/html/rfc4825 XCAP] documents like [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) and P2P overlays

  * Setup up [http://www.tech-invite.com/SIPWGs/03-WG-SIMPLE/Drafts/draft-ietf-simple-chat-02.txt ad-hoc multi-party chat sessions] with an MSRP chat server (under construction)

  * Alarms systems for SIP calls (VoIP sessions with RTP)

Using these scripts is easy to prototype [wiki:RichPresence Rich Presence], IM and VoIP services based on the SIP protocol. 

To use these tools 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]

== Download  == 

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

The software will be available from:

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

== Integration with third-party projects ==

PyPjUA will be first integrated into [http://tribler.org Tribler]. Tribler is an application that enables its users to find, enjoy and share content. With content we mean video, audio, pictures, and much more. PyPjUA will provides real-time communications features that will allow users that have downloaded Tribler to:

 * Interact in real time with each other using rich Presence, Interactive messaging and audio

 * Communicate with other people that have access to SIP services from various SIP operators across the world

== Developer program ==

To become an active developer to this program please 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).

== Support == 

The software is developed and supported by [http://ag-projects.com AG Projects].