SIP SIMPLE Client SDK

= Installation =

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

== Prerequisites ==

The following computing platform have been tested and are fully supported:

* Linux (i386 and amd64 architectures)
* MacOSX (Intel, 32 and 64 bit architectures)
* Microsoft Windows (XP, Vista and 7)

== Current Stable Version ==

Released on July 7th, June 22nd, 2010

|| '''Package Name''' || '''Version'''||'''Description'''||
|| python-sipsimple ||0.15.1|| ||0.15.0|| SIP SIMPLE client SDK||
|| python-msrplib ||0.12.0|| MSRP client library||
|| python-xcaplib ||1.0.14|| XCAP client library||
|| sipclients|| 0.15.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 Unstable (Sid) ===

{{{
# AG Projects software
deb http://ag-projects.com/debian unstable main
deb-src http://ag-projects.com/debian unstable main
}}}

=== Debian Stable (Lenny) ===

{{{
# AG Projects software
deb http://ag-projects.com/debian stable main
deb-src http://ag-projects.com/debian stable main
}}}

=== Ubuntu Karmic (9.10) ===

{{{
# AG Projects software
deb http://ag-projects.com/ubuntu karmic main
deb-src http://ag-projects.com/ubuntu karmic 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
}}}

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

== Building Instructions ==

Complete building and installation instructions for the corresponding platforms are available in:

|| [source:docs/Install.linux Install.linux] || Generic Linux ||
|| [source:docs/Install.debian Install.debian] || Debian Linux ||
|| [source:docs/Install.ubuntu Install.ubuntu] || Ubuntu Linux ||
|| [source:docs/Install.osx-10.5 Install.osx-10.5] || MacOSX 10.5 Leopard ||
|| [source:docs/Install.osx-10.6 Install.osx-10.6] || MacOSX 10.6 Snow Leopard ||
|| [source:docs/Install.windows Install.windows] || Microsoft Windows ||

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