SIP SIMPLE Client SDK

== Description == 

SIP SIMPLE client is Python software library built on top of [http://pjsip.org 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

voice, video, 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, session based Interactive  Messaging (IM) 

combined with voice and video sessions, 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 [http://www.rfc3261.net 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 to /etc/apt/sources.list:

{{{

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 MacOSX 10.5 (Leopard) on an Intel architecture add to /sw/etc/apt/sources.list:

{{{

deb http://ag-projects.com/fink local main

deb http://ag-projects.com/fink stable main crypto

deb http://ag-projects.com/fink unstable main crypto

}}}

Update the list of available software and install the software:

{{{

sudo apt-get update

sudo apt-get install sipclient

}}}

For other Unix distributions

To obtain the source code as tar archive go to:

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

Windows binaries are on the roadmap.

== Testing ==

SIP SIMPLE client is closely developed together with and tested against the most popular SIP SIMPLE server software available today: [http://opensips.org OpenSIPs], [http://openxcap.org OpenXCAP] and [http://msrprelay.org MSRPRelay]. Included 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 transfer using MSRP protocol

 * sip_message - Send/receive text in page mode using SIP 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 presence policy and buddy lists on an XCAP server

For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]

== Supported platforms and normative references ==

As a library with a high-level API, the toolkit can be used to add voice, IM and Presence functionality to any network devices as long as Python/C environment is supported by such platform.

For a list of implemented normative references see the list of RFCs implemented by the PJSIP project. Additional to PJSIP,  this project implements, [http://tools.ietf.org/html/rfc4976 RFC MSRP protocol], [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], [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], [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt Bonjour] (LAN broadcast) and [http://tools.ietf.org/html/rfc3263 RFC 3263] (Locating SIP Services), [http://tools.ietf.org/html/draft-ietf-simple-chat-02 ad-hoc multi-party chat sessions] with an MSRP chat server

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

== Source code access ==

Version control is done using [http://darcs.net darcs] . The darcs repository can be fetched with:

{{{

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

}}}

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

{{{

darcs pull

}}}

If you wish to contribute and become an active developer of this project, send your request by email to pypjua-devel@ag-projects.com.