SIP SIMPLE Client SDK

h1. Installation

h2. Prerequisites

The following platforms have been tested and are fully supported:

* Linux Debian and Ubuntu (i386 and amd64 architectures)
* MacOSX 10.6, 10.7, 10.8 (Intel 32 bit architecture)
* Microsoft Windows (XP, Vista and 7)

h2. Current Version

"Released on October 29th, 26th, 2012":http://sipsimpleclient.com/news/11

| *Package Name* | *Version*|*Description*|
| python-sipsimple |0.31.0| SIP SIMPLE client SDK|
| python-msrplib |0.15.0| MSRP client library|
| python-xcaplib |1.0.17| XCAP client library|
| sipclients| 0.31.0 | Command Line Tools|

h2. Tar Archives

The software is available as a tar archive at:

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

h2. Debian Packages

Install the AG Projects debian software signing key:

<pre>
wget http://download.ag-projects.com/agp-debian-gpg.key
sudo apt-key add agp-debian-gpg.key
</pre>

Add these lines to /etc/apt/sources.list:

h3. Debian Stable (Squeeze)

<pre>
# AG Projects software
deb http://ag-projects.com/debian stable main
deb-src http://ag-projects.com/debian stable main
</pre>

h3. Debian Unstable (Sid)

<pre>
# AG Projects software
deb http://ag-projects.com/debian unstable main
deb-src http://ag-projects.com/debian unstable main
</pre>

h3. Ubuntu Maverick (10.10)

<pre>
# AG Projects software
deb http://ag-projects.com/ubuntu maverick main
deb-src http://ag-projects.com/ubuntu maverick main
</pre>

h3. Ubuntu Natty (11.04)

<pre>
# AG Projects software
deb http://ag-projects.com/ubuntu natty main
deb-src http://ag-projects.com/ubuntu natty main
</pre>

h3. Ubuntu Oneiric (11.10)

<pre>
# AG Projects software
deb http://ag-projects.com/ubuntu oneiric main
deb-src http://ag-projects.com/ubuntu oneiric main
</pre>

h3. Ubuntu Precise (12.04)

<pre>
# AG Projects software
deb http://ag-projects.com/ubuntu precise main
deb-src http://ag-projects.com/ubuntu precise main
</pre>

Update the list of available packages:

<pre>
sudo apt-get update
</pre>

Install SIP SIMPLE client SDK:

<pre>
sudo apt-get install python-sipsimple
</pre>

Install Command Line Tools:

<pre>
sudo apt-get install sipclients
</pre>

h2. Version Control Repository

The trunk is stable and recommended for anyone that wishes to use the library. The project policy is to add only tested code to the main repository. Known issues are listed in the "tickets interface":http://sipsimpleclient.com/report.

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

h3. SIP SIMPLE Client SDK

<pre>
darcs get http://devel.ag-projects.com/repositories/python-sipsimple
</pre>

h4. Dependencies

Several dependencies provided by AG Projects can be accessed in the same way:

<pre>
* darcs get http://devel.ag-projects.com/repositories/python-xcaplib
* darcs get http://devel.ag-projects.com/repositories/python-msrplib
* darcs get http://devel.ag-projects.com/repositories/python-application
* darcs get http://devel.ag-projects.com/repositories/python-backports
* darcs get http://devel.ag-projects.com/repositories/python-gnutls
* darcs get http://devel.ag-projects.com/repositories/python-cjson
* darcs get http://devel.ag-projects.com/repositories/python-greenlet
* darcs get http://devel.ag-projects.com/repositories/python-eventlib
</pre>

h3. Command Line Tools

<pre>
darcs get http://devel.ag-projects.com/repositories/sipclients
</pre>

To obtain the incremental changes after the initial get, go to the python-sipsimple and sipclients directory and run:

<pre>
darcs pull -a
</pre>

h2. Dependencies

* python http://python.org 2.6, 2.7
* python-application http://pypi.python.org/simple/python-application >=1.4.0
* python-backports http://download.ag-projects.com/SipClient >=1.0.0
* python-cjson http://pypi.python.org/pypi/python-cjson/ >=1.0.5
* python-dateutil http://niemeyer.net/python-dateutil >=1.4
* python-eventlib http://download.ag-projects.com/SipClient >=0.1.0
* python-greenlet http://download.ag-projects.com/SipClient =0.4.0
* python-gnutls http://pypi.python.org/simple/python-gnutls >=1.1.9
* python-lxml http://codespeak.net/lxml >=2.1.2
* python-msrplib http://download.ag-projects.com/MSRP >=0.15.0
* python-xcaplib http://download.ag-projects.com/XCAP >=1.0.17
* cython http://www.cython.org >=0.13.0
* dnspython http://www.dnspython.org >=1.6.0
* twisted http://twistedmatrix.com/trac >=8.1.0
* zope-interface http://www.zope.org >=3.3.1

h2. Building Instructions

Complete building and installation instructions for the corresponding platforms are available in the doc folder that comes with the source code:

| Install.linux | Generic Linux |
| Install.debian | Debian Linux |
| Install.ubuntu | Ubuntu Linux |
| Install.windows | Microsoft Windows |
| Install.osx-10.6 | MacOSX 10.6 Snow Leopard |
| Install.osx-10.7 | MacOSX 10.7 Lion|
| Install.osx-10.7 | MacOSX 10.8 Mountain Lion|

h2. Audio Device Sharing

For audio device sharing on Linux see [[SipAudioDeviceSharingLinux|Audio Device Sharing]]

h2. Testing

To test SIP SIMPLE client SDK, you can use the Command Line Tools provided by the sipclients package. The Command Line Tools are compatible with MacOSX and Linux only.

See [[SipTesting|Testing]] page for how to test the SDK.