Version 115 (Adrian Georgescu, 08/23/2008 11:29 am) → Version 116/574 (Adrian Georgescu, 08/26/2008 07:18 pm)

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

== Project description ==

PyPjUA is Python software library for [ PJSIP] C SIP stack that together with a clever middleware allows for easy development of real-time communications end-points based on [ SIP protocol] with [wiki:RichPresence rich presence] 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. 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).

Using this software you are able to create elegant real-time communications applications without having to read or understand [ the +1200 RFC documents] behind it.

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

== End-user experiences ==

Using this toolkit you can develop in short time a skinable and cross-platform SIP User Agent that can be used for real-time Internet communications. 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.

* VoIP calls using Internet codecs (wide-band Speex, (Speex, iLBC) and G.711 for compatibility with PSTN
* Multiple RTP audio/msrp/video streams per session (for live broadcasting applications)
* Session based IM with voice/video for rich end-to-end communications
Zero configuration when 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 for RTP media and MSRP relay Relay for IM and file transfer
* Sharing desktop screen using VNC protocol
* Video calls

The software library has been is tested against the most popular SIP server software: [ OpenSER], [ OpenXCAP], [ MediaProxy] and [ MSRPRelay] servers. To test the software you can register a free SIP SIMPLE account on [ 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 [ MSRP sessions] between end-points with public IP or behind NAT by using [ MSRP relay]
* Setup up VoIP sessions between end-points with public IP adresses or behind NAT by using ICE and media relay
* [ PUBLISH] and [ SUBSCRIBE/NOTIFY to SIP events] like [ presence], [ xcap-diff], [ watcher-info], [ conference], [ message-summary]
* Manage presence policy the form of full or partial [ XCAP] documents like [ pres-rules], [ resource-lists, rls-services] and [ pidf-manipulation]
* Lookup of SIP buddies using [ Bonjour] (LAN broadcast), [ RFC 3263] (Locating SIP Services) and P2P overlays
* Setup up [ ad-hoc multi-party chat sessions] with an MSRP chat server (under construction)

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 []

== 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:


== Integration with third-party projects ==

PyPjUA will be first integrated into [ 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 []

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 [ ToIP (RFC 4103)] and MSRP).

== Support ==

The software is developed and supported by [ AG Projects].