SIP SIMPLE Client SDK

= Description =

[http://www.tech-invite.com/Ti-sip-IDs-SIMPLE.html#charter SIP SIMPLE] client is a SIMPLE SIP client. Which leads to the question how SIMPLE is [http://www.tech-invite.com/Ti-sip-IDs-SIMPLE.html#charter SIMPLE]. So let's try again:

[[Image(htdocs:SIPSIMPLE-client.png, align=right, nolink)]]

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 end-points, while hiding the complex underlying functionality behind an easy to use high-level application-programming interface. This project adds next to the SDP negotiation, audio codecs and NAT traversal functionality provided by PJSIP, rich communications combining session based Interactive Messaging (IM), voice and video streams, 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. 

Another way to put it, 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.

Once completed, you will be able to use its functionality in your favorite UNIX console, embed it into a networked device or create a skinable GUI for it on your favorite OS in no time.  

== Download and installation ==

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

}}}

Step by step installation instructions are available in [source:docs/INSTALL.linux INSTALL.linux] and [source:docs/INSTALL.osx INSTALL.osx]. For other operating systems or to obtain the full 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 the library ==

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:CommandLineTools 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. 

 * [wiki:sip_register sip_register] - REGISTER a SIP end-point with a SIP Registrar

 * [wiki:sip_rtp_audio_session sip_rtp_audio_session] - Setup a voice audio session (Voice over IP)

 * [wiki:sip_msrp_im_session sip_msrp_im_session] - Setup an IM session using MSRP protocol

 * [wiki:sip_msrp_file_transfer sip_msrp_file_transfer] - Perform file transfer using MSRP protocol

 * [wiki:sip_message sip_message] - Send/receive text in page mode using SIP MESSAGE method

 * [wiki:sip_publish_presence sip_publish_presence] - PUBLISH presence to a SIP Presence Agent

 * [wiki:sip_subscribe_presence sip_subscribe_presence]  - SUBSCRIBE to presence information

 * [wiki:sip_subscribe_winfo sip_subscribe_winfo] - SUBSCRIBE to watcher list on a SIP Presence Agent

 * [wiki:sip_subscribe_rls sip_subscribe_rls] - SUBSCRIBE to lists managed by Resource List Server

 * [wiki:xcapclient xcapclient] - PUT/GET/DELETE full or partial documents on an XCAP server

 * [wiki:xcap_pres_rules xcap_pres_rules] - Manage entries in the pres-rules XCAP document

== Supported platforms ==

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

== Normative references ==

Additional to the SIP standards implemented by the underlying [http://www.pjsip.org/sip_media_features.htm PJSIP library] and exposed by SIP SIMPLE client in a Python API, this project implements in Python language the following standards:

 * XCAP protocol stack and client [http://www.tools.ietf.org/html/rfc4825 RFC4825]

 * XCAP pres-rules [http://www.tools.ietf.org/html/rfc5025 RFC5025]

 * XCAP resource-lists and rls-services [http://www.tools.ietf.org/html/rfc4826 RFC4826]

 * XCAP pidf-manipulation [http://www.tools.ietf.org/html/rfc4827 RFC4827]

 * MSRP protocol stack and client [http://tools.ietf.org/html/rfc4975 RFC4975]

 * MSRP protocol relay extension [http://tools.ietf.org/html/rfc4976 RFC4976]

 * MSRP multi-party chat [http://tools.ietf.org/html/draft-ietf-simple-chat-02 draft-ietf-simple-chat-02]

 * SIP PUBLISH method [http://tools.ietf.org/html/rfc3903 RFC3903]

 * SIP SUBSCRIBE and SIP NOTIFY methods [http://tools.ietf.org/html/rfc3265 RFC3265]

 * Rich Presence Information Data model and Format (RPIDF) [http://tools.ietf.org/html/rfc3856 RFC3856], [http://tools.ietf.org/html/rfc3863 RFC3863 ], [http://tools.ietf.org/html/rfc4479 RFC4479]

 * XCAP-diff event package [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt draft-ietf-simple-xcap-diff-09]

 * Watcher Information event package [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]

 * Conference event package [http://tools.ietf.org/html/rfc4575 RFC4575]

 * Message Waiting Indication event package [http://tools.ietf.org/html/rfc3842 RFC3842]

 * Bonjour multicast DNS [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt draft-lee-sip-dns-sd-uri-02]

 * Locating SIP services [http://tools.ietf.org/html/rfc3263 RFC3263]

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