SIP SIMPLE Client SDK

= Description =

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

SIP SIMPLE client is Python software library built on top of PJSIP that

together with middleware allows for easy development of Client/Server and

Peer-to-Peer Internet communications end-points based on SIP SIMPLE family

of protocols for voice, video, presence, instant 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 package supports to the SDP negotiation, audio codecs and

NAT traversal functionality provided by PJSIP and will thus deliver rich

communications combining instant messaging (IM), voice and video streams. It

also supports file transfer and multi-party chat sessions using MSRP

protocol, publication and subscription for rich presence information such as

availability, moods, activities and geo-location, management for presence

rules, resource lists, RLS services using XCAP protocol.

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. 

== Background ==

SIP stands for 'Sessions Initiation Protocol', an IETF standard described by

RFC3261. SIP is an application-layer control protocol that can establish,

modify and terminate multimedia sessions such as Internet telephony calls

(VoIP). Media can be added to (and removed from) an existing session.

SIP transparently supports name mapping and redirection services, which

supports personal mobility, users can maintain a single externally visible

address identifier, which can be in the form of a standard email address or

E.164 telephone number regardless of their physical network location.

SIP allows the endpoints to negotiate and combine any type of session they

mutually understand like video, instant messaging (IM), file transfer,

desktop sharing and provides a generic event notification system with

real-time publications and subscriptions about state changes that can be

used for asynchronous services like presence, message waiting indicator and

busy line appearance.

== Features ==

As a library with a high-level [wiki:PyPJUADesign 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.

Additional to the SIP standards implemented by the underlying PJSIP library,

this project implements:

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

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

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

 * 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-info [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]

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

 * Message summary [http://tools.ietf.org/html/rfc3842 RFC3842]

 * Presence rules [http://www.tools.ietf.org/html/rfc5025 RFC5025]

 * Resource-lists and RLS-services [http://www.tools.ietf.org/html/rfc4826 RFC4826]

 * PIDF manipulation [http://www.tools.ietf.org/html/rfc4827 RFC4827]

 * Bonjour multicast DNS [http://www.ietf.org/internet-drafts/draft-lee-sip-dns-sd-uri-03.txt draft-lee-sip-dns-sd-uri-03]

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

 * MSRP ad-hoc multi-party chat sessions [http://tools.ietf.org/html/draft-ietf-simple-chat-03 draft-ietf-simple-chat-03]

== Download ==

=== Tarball ===

Tarball with the latest released version is available at [http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/]

=== Binary packages ===

Binary packages are available for Debian or Ubuntu on i386 and amd64 architectures. To install add the following lines to /etc/apt/sources.list:

{{{

deb	http://ag-projects.com/debian unstable main

deb-src http://ag-projects.com/debian unstable main

}}}

Install AG Projects debian repository signing key:

{{{

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

apt-key add agp-debian-gpg.key

}}}

Install the software:

{{{

apt-get update

apt-get install sipclient

}}}

Install dependencies that are not yet available as debian package:

{{{

sudo apt-get install mercurial python-setuptools

# Download and install eventlet for twisted:

hg clone http://devel.ag-projects.com/~denis/cgi-bin/hgweb.cgi/eventlet_twisted

cd eventlet_twisted

# To update the eventlet_twisted at a later date:

cd eventlet_twisted

hg pull

hg update

sudo python setup.py install

}}}

=== Version control ===

The source code is managed using [http://darcs.net darcs] version control tool. The darcs repository can be fetched with:

{{{

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

}}}

To obtain the incremental changes after the initial get, go to the sipsimpleclient directory and run:

{{{

cd sipsimpleclient

darcs pull

}}}

== Installation ==

Installation instructions for the corresponding platforms are available at:

 * [source:docs/INSTALL.debian INSTALL.debian]

 * [source:docs/INSTALL.linux INSTALL.linux]

 * [source:docs/INSTALL.osx INSTALL.osx]

 * [source:docs/INSTALL.freebsd INSTALL.freebsd]

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 command line tools are available for setting up audio, Instant Messaging 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_audio_session] - Setup a voice audio session (Voice over IP)

 * [wiki:sip_msrp_im_session sip_im_session] - Setup IM session and 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 content of pres-rules XCAP document

 * [wiki:xcap_rls_services] - Manage content of RLS services XCAP document

== Support ==

To request support you must open a ticket. To open ticket please [/register Register] first. The source browser and ticketing system are available only for registered users. 

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