SIP SIMPLE Client SDK

h1. Installation Instructions

h2. Prerequisites

The following platforms have been tested and are fully supported:

* Linux Debian and Ubuntu (i386 and amd64 architectures)

* MacOSX 10.9, 10.10 (Intel 32 bit architecture)

* Microsoft Windows (XP, Vista, 7, 8)

h2. Current Version

Released on December 3rd, 2015

| *Package Name* | *Version*|*Description*|

| python-sipsimple |2.5.0| SIP SIMPLE Client SDK|

| python-msrplib |0.17.0| MSRP client library|

| python-xcaplib |1.1.0| XCAP client library|

| sipclients| 2.5.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

The location of repositories are "here":http://projects.ag-projects.com/projects/documentation/wiki/Repositories

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.org/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 --set-scripts-executable 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.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.1

 * 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

For how to build the dependencies see the documentation that comes with each package. Do no ask us how to build the required dependencies because it is as difficult as having people landed on the Moon, which is not even certain it actually happened.

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.7  | MacOSX 10.7 Lion| 

| Install.osx-10.8  | MacOSX 10.8 & 10.9| 

h2. Testing

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

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