« Previous - Version 126/574 (diff) - Next » - Current version
Adrian Georgescu, 09/01/2008 04:01 pm

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


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 both the to client and to the corresponding servers 'the missing' SIP-SIMPLE features for rich presence (RLS-services, R-PIDF, XCAP) and session based interactive messaging based on MSRP.

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


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]

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). Some of the things possible with this library are listed here:

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

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]


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

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

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).


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

SIPSIMPLE-Manual.jpg (4.6 kB) Adrian Georgescu, 04/16/2010 11:27 am

sipsimple-components.png - SIP SIMPLE client components (94 kB) Adrian Georgescu, 01/13/2012 06:12 pm