SIP SIMPLE Client SDK

= Installation =

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

== Prerequisites ==

A physical sound card is required.

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

 * Linux (i386 and amd64 architectures)

 * MacOSX (Intel, 32 and 64 bit architectures)

The software can be theoretically ported to any operating systems supported by the cross-platform [http://www.portaudio.com/ PortAudio] audio library. 

Support for Microsoft Windows is work in progress. 

== Current Release ==

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

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

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

Building instructions for the corresponding platforms are available at:

 * [source:docs/Install.linux Install.linux] - Linux manual installation 

 * [source:docs/Install.debian Install.debian] - Debian and Ubuntu installation 

 * [source:docs/Install.osx Install.osx] - MacOSX 10.5 Leopard and 10.6 Snow Leopard

== Testing ==

To test SIP SIMPLE client SDK, you can use the Command Line Tools provided by the sipclients package.

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