« Previous - Version 190/574 (diff) - Next » - Current version
Adrian Georgescu, 10/19/2008 12:19 pm

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


SipClient is Python software library built on top of PJSIP that together
with an elegant middleware allows for easy development of Client/Server or
Peer-to-Peer Internet communications end-points based on SIP protocol with
rich Presence, Interactive Messaging (IM) and File Transfer capabilities.


The goal of this project is to deliver the best Python based 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 provides session based Interactive Messaging (IM) using MSRP
protocol, multiple streams support and 'the missing' SIP-SIMPLE features for
rich presence: presence rules, resource lists, RLS services, rich PIDF and
XCAP policy.

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

Several [wiki:testscripts command line tools] are available for setting up real time voice, IM
and file transfer sessions, publish and subscribe to presence or other type
of events:

  • sip_register - REGISTER a SIP end-point with a SIP REGISTRAR
  • sip_rtp_audio_session - Setup a voice audio session (VoIP)
  • sip_msrp_im_session - Setup an IM session using MSRP protocol
  • sip_msrp_file_transfer - File Transfer session using MSRP protocol
  • sip_message - Send text message in page mode using MESSAGE method
  • sip_publish_presence - PUBLISH presence to a SIP Presence Agent
  • sip_subscribe_presence - SUBSCRIBE to presence information
  • sip_subscribe_winfo - SUBSCRIBE to watcher list on a SIP Presence Agent
  • sip_subscribe_rls - SUBSCRIBE to lists managed by Resource List Server
INSTALL procedure

The software has been tested on Linux Debian and MacOSX 10.5 (Leopard).

For people running Debian testing or unstable on an i386 architecture there is an official public repository provided by AG Projects. Install the AG Projects debian software signing key:

wget http://download.ag-projects.com/agp-debian-gpg.key
apt-key add agp-debian-gpg.key

Add the following lines to /etc/apt/sources.list

  1. AG Projects software
    deb http://ag-projects.com/debian unstable main
    deb-src http://ag-projects.com/debian unstable main

Update the list of available software and install the software:

apt-get update
apt-get install sipclient

For other distributions or to obtain the source code go to:

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

To obtain access to the version controlled software repository:

darcs get http://devel.ag-projects.com/repositories/pypjua

End-user experiences

The 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)
  • Parallel forking to multiple SIP devices
  • Presence using SIP SIMPLE (PUBLISH, SUBSCRIBE, NOTIFY and XCAP policy)
  • Interactive Messaging (IM) and File transfer using MSRP protocol
  • Desktop sharing
  • Video calls
Testing the library

Besides the Python software library itself, the repository contains ready to use fully featured [wiki:testscripts command-line examples scripts] that can be used to:

For testing, 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]


We are looking for contributions related to DHT overlay (P2PSIP), desktop sharing, video sessions and real time text using RTP [http://www.ietf.org/rfc/rfc4103.txt ToIP (RFC 4103)].

If you wish to become an active developer of this project, send your request by email to [mailto: ].

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