Version 220 (Adrian Georgescu, 10/20/2008 10:01 pm) → Version 221/574 (Adrian Georgescu, 10/20/2008 10:02 pm)

== Description ==

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

The goal of this project is to deliver the best Open Source Python
library 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 beyond basic audio calls, multiple streams support for IM, voice and video sessions,
Interactive Messaging (IM), file transfer and multi-party chat sessions using MSRP protocol,
publication and subscription for rich presence information like availability, moods, activities and geo-location, management for presence rules,
resource lists, RLS services using XCAP protocol.

Shortly said, this software allows you to create elegant real-time communications applications without having to read [ the +1200 RFC documents] behind it. If you read them all, some antidepressant and desintoxication is recommended after this effort.

== Download ==

For Debian testing or unstable on an i386 architecture, add the following lines to /etc/apt/sources.list

deb unstable main
deb-src unstable main

Update the list of available software and install the software:

apt-get update
apt-get install sipclient

=== Other Unix distributions ===

To obtain the source code as tar archive go to:


== Source code access ==

SipClient source code is using [ darcs] for version control. The darcs repository can be fetched with:

darcs get

To obtain the changes after the intial get, go to the pypjua directory and run:

darcs pull

== Testing ==

This SIP SIMPLE software library has been closely developed together with and tested against the most popular SIP SIMPLE server software available today: [ OpenSIPs], [ OpenXCAP] and [ MSRPRelay]. With the library, a set of [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 (Voice over IP)
* sip_msrp_im_session - Setup an IM session using MSRP protocol
* sip_msrp_file_transfer - Perform file transfers 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
* xcapclient - Manage documents using XCAP protocol

For testing, you can use your own infrastructure or register a free SIP SIMPLE account on []

== End-user experiences ==

As a library with a high-level API, the toolkit can also be used to add voice, IM 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:

* Setup up VoIP sessions using Internet wide-band codecs
* Setup Interactive Messaging (IM) and File Transfer ([ MSRP sessions]) with or without support from a [ MSRP relay]
* Create SIP SIMPLE end-points: [ PUBLISH], SUBSCRIBE, NOTIFY for [ SIP events], presence data model and format ([ RFC3856], [ RFC3863 ], [ RFC4479]), [ xcap-diff], watcher-info ([ RFC3857],[ RFC3858] ), [ conference], [ message-summary]
* Manage [ XCAP] documents [ pres-rules], [ resource-lists, rls-services] and [ pidf-manipulation]
* Discover SIP end-point using [ Bonjour] (LAN broadcast) and [ RFC 3263] (Locating SIP Services)
* Setup up [ ad-hoc multi-party chat sessions] with an MSRP chat server (under construction)

== License ==

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

== Support ==

To open ticket please Register first. The ticketing support system is available only for registered users. Please beware that the support is provided by the community on a best-effort basis.

If you wish to contribute and become an active developer of this project, send your request by email to