SIP SIMPLE Client SDK

= Installation guide =

[[TOC(WikiStart, Sip*, depth=3)]]

== Supported platforms ==

Currently i386, amd64 and ppc architectures have been tested and are fully supported on the following operating systems:

 * Linux

 * MacOSX

 * FreeBSD

Porting to other operating systems (like Windows, Symbian and iPhone) is possible as the Python environment and [http://www.pjsip.org/sip_media_features.htm#platforms PJSIP] are supported by these platform.

== Debian package ==

For people running Debian 5.0 or Ubuntu 8.10 a debian package with the stable version is available in the public repository provided by AG Projects. To install the debian package  add these lines in /etc/apt/sources.list

{{{

# AG Projects software

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

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

}}}

Install the AG Projects debian software signing key:

{{{

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

apt-key add agp-debian-gpg.key

}}}

After that, run:

{{{

apt-get update

apt-get install sipclient

}}}

== Tar archive ==

A tar archive with the current stable version is available at:

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

== Development version ==

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

{{{

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

}}}

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

{{{

cd python-sipsimple

darcs pull

}}}

== Building instructions ==

Building instructions for the corresponding platforms are available at:

 * [source:docs/INSTALL.linux INSTALL.linux]

 * [source:docs/INSTALL.osx INSTALL.osx]

 * [source:docs/INSTALL.freebsd INSTALL.freebsd]

The build process can be fine-tuned for various options (like for using a specific version of underlying pjsip library):

{{{

adigeo@ag-imac3:python setup.py build_ext --help

Common commands: (see '--help-commands' for more)

  setup.py build      will build the package underneath 'build/'

  setup.py install    will install the package

Global options:

  --verbose (-v)  run verbosely (default)

  --quiet (-q)    run quietly (turns verbosity off)

  --dry-run (-n)  don't actually do anything

  --help (-h)     show detailed help message

Options for 'PJSIP_build_ext' command:

  --build-lib (-b)        directory for compiled extension modules

  --build-temp (-t)       directory for temporary files (build by-products)

  --inplace (-i)          ignore build-lib and put compiled extensions into

                          the source directory alongside your pure Python

                          modules

  --include-dirs (-I)     list of directories to search for header files

                          (separated by ':')

  --define (-D)           C preprocessor macros to define

  --undef (-U)            C preprocessor macros to undefine

  --libraries (-l)        external C libraries to link with

  --library-dirs (-L)     directories to search for external C libraries

                          (separated by ':')

  --rpath (-R)            directories to search for shared C libraries at

                          runtime

  --link-objects (-O)     extra explicit link objects to include in the link

  --debug (-g)            compile/link with debugging information

  --force (-f)            forcibly build everything (ignore file timestamps)

  --compiler (-c)         specify the compiler type

  --swig-cpp              make SWIG create C++ files (default is C)

  --swig-opts             list of SWIG command line options

  --swig                  path to the SWIG executable

  --pyrex-cplus           generate C++ source files

  --pyrex-create-listing  write errors to a listing file

  --pyrex-include-dirs    path to the Cython include files (separated by ':')

  --pyrex-c-in-temp       put generated C files in temp directory

  --pyrex-gen-pxi         generate .pxi file for public declarations

  --pjsip-svn-repo        PJSIP SVN repository to checkout from

  --pjsip-svn-revision    PJSIP SVN revision to fetch

  --pjsip-clean-compile   Clean PJSIP tree before compilation

  --help-compiler         list available compilers

}}}

== Upgrade instructions ==

 * [browser:docs/Upgrade.txt Upgrade guide]

== How to un-install ==

 * [browser:docs/UnINSTALL.txt Uninstall guide]