SIP SIMPLE Client SDK

= Installation =

[[TOC(SipInstallation, depth=3)]]

== Prerequisites ==

The following platforms have been tested and are fully supported:

 * Linux Debian and Ubuntu (i386 and amd64 architectures)

 * MacOSX 10.6 and 10.7 (Intel 32 bit architecture)

 * Microsoft Windows (XP, Vista and 7)

== Current Version ==

Released on December 20th, 2011

|| '''Package Name''' || '''Version'''||'''Description'''||

|| python-sipsimple ||0.20.0|| SIP SIMPLE client SDK||

|| python-msrplib ||0.14.2|| MSRP client library||

|| python-xcaplib ||1.0.16|| XCAP client library||

|| sipclients|| 0.20.0 || Command Line Tools||

== Tar Archives ==

The software is available as a tar archive at:

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

== Debian Packages ==

Install the AG Projects debian software signing key:

{{{

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

sudo apt-key add agp-debian-gpg.key

}}}

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

=== Debian Stable (Squeeze) ===

{{{

# AG Projects software

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

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

}}}

=== Debian Unstable (Sid) ===

{{{

# AG Projects software

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

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

}}}

=== Ubuntu Lucid (10.04)   ===

{{{

# AG Projects software

deb	http://ag-projects.com/ubuntu lucid main

deb-src http://ag-projects.com/ubuntu lucid main

}}}

=== Ubuntu Maverick (10.10)  ===

{{{

# AG Projects software

deb	http://ag-projects.com/ubuntu maverick main

deb-src http://ag-projects.com/ubuntu maverick main

}}}

=== Ubuntu Natty (11.04)  ===

{{{

# AG Projects software

deb	http://ag-projects.com/ubuntu natty main

deb-src http://ag-projects.com/ubuntu natty main

}}}

=== Ubuntu Oneiric (11.10)  ===

{{{

# AG Projects software

deb	http://ag-projects.com/ubuntu oneiric main

deb-src http://ag-projects.com/ubuntu oneiric main

}}}

Update the list of available packages:

{{{

sudo apt-get update

}}}

Install SIP SIMPLE client SDK:

{{{

sudo apt-get install python-sipsimple

}}}

Install Command Line Tools:

{{{

sudo apt-get install sipclients 

}}}

== 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 [http://sipsimpleclient.com/report tickets interface].

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

=== SIP SIMPLE client SDK ===

{{{

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

}}}

=== Command Line Tools ===

{{{

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

}}}

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

{{{

darcs pull -a

}}}

== Dependencies ==

 * python                   http://python.org                                2.6, 2.7

 * python-application       http://pypi.python.org/simple/python-application  >=1.2.8

 * 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-eventlet          http://download.ag-projects.com/SipClient         =0.8.11

 * 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.14.2

 * python-xcaplib           http://download.ag-projects.com/XCAP             >=1.0.15

 * cython                   http://www.cython.org                    >=0.13.0 & <0.15

 * 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

 * Python Imaging Library   http://pypi.python.org/pypi/PIL/                  >=1.1.6

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

== Audio Device Sharing ==

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

== 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 [wiki:SipTesting Testing] page for how to test the SDK.