SIP SIMPLE Client SDK

== Description == 

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.

== Deliverables ==

The goal of this project is to deliver the best Python based Open Source

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 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 library is tested against the most popular SIP server software available today: [http://opensips.org OpenSIPs], [http://openxcap.org OpenXCAP] and [http://msrprelay.org MSRPRelay]. 

Besides 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 (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

{{{

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

  * Register SIP end-points

  * Setup up VoIP sessions using wide-band codecs

  * Setup Interactive Messaging (IM) and file-transfer ([http://tools.ietf.org/html/rfc4975 MSRP sessions]) with or without support from a [http://tools.ietf.org/html/rfc4976 MSRP relay]

  * Simulate SIP SIMPLE end-points: [http://tools.ietf.org/html/rfc3903 PUBLISH], SUBSCRIBE, NOTIFY for [http://tools.ietf.org/html/rfc3265 SIP events], presence  data model and format ([http://tools.ietf.org/html/rfc3856 RFC3856], [http://tools.ietf.org/html/rfc3863 RFC3863 ], [http://tools.ietf.org/html/rfc4479 RFC4479]), [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt xcap-diff], watcher-info ([http://tools.ietf.org/html/rfc3857 RFC3857],[http://tools.ietf.org/html/rfc3858 RFC3858] ), [http://tools.ietf.org/html/rfc4575 conference], [http://tools.ietf.org/html/rfc3842 message-summary]

  * Manage [http://www.tools.ietf.org/html/rfc4825 XCAP] documents [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)

  * Setup up [http://tools.ietf.org/html/draft-ietf-simple-chat-02 ad-hoc multi-party chat sessions] with an MSRP chat server (under construction)

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

== Support ==

The project is supported via this wiki collaboration system provided at:

http://pypjua.org

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 pypjua-devel@ag-projects.com.