Version 333 (Adrian Georgescu, 11/30/2008 09:01 am) → Version 334/574 (Adrian Georgescu, 11/30/2008 09:05 am)

= Description =

[[Image(htdocs:SIPSIMPLE-client.png, align=right, nolink)]]
SIP SIMPLE client is a Python software library built on top of [ PJSIP] that together
with [wiki:MiddlewareDesign middleware] allows for easy development of Client/Server and
Peer-to-Peer Internet communications end-points based on SIP SIMPLE protocols for
voice, video, presence, instant messaging (IM) and file transfer capabilities.

The goal of this project is to deliver the best Open Source Python library for rich featured SIP end-points, while hiding the complex underlying functionality behind an easy to use high-level application-programming interface. This package supports to the SDP negotiation, audio codecs and NAT traversal functionality provided by PJSIP and will thus deliver rich communications combining instant messaging (IM), voice and video streams. It also supports file transfer and multi-party chat sessions using MSRP protocol, publication and subscription for rich presence information such as availability, moods, activities and geo-location, management for presence rules, resource lists, RLS services using XCAP protocol.

The software allows you to create elegant real-time communications applications without having to read [ the +1200 RFC documents] behind it.

The software is provided under the [source:LICENSE GPL LICENSE]

== Status ==

See [/roadmap?show=all Completed milestones], [/roadmap Roadmap] and [source:TODO TODO] list for information about the project progress.

== Download and installation ==

=== Tarball ===

Tarball with the latest released version is available at []

=== Binary packages ===

Binary packages are available for For Debian or Ubuntu on i386 and amd64 architectures. To architectures, to install add the following lines to /etc/apt/sources.list:

deb unstable main
deb-src unstable main

Install AG Projects debian repository signing key:

apt-key add agp-debian-gpg.key

Install the software:

apt-get update
apt-get install sipclient

Install dependencies that are not yet available as debian package:

sudo apt-get install mercurial python-setuptools
# Download and install eventlet for twisted:
hg clone
cd eventlet_twisted
sudo python install

# To update the eventlet_twisted at a later date:
cd eventlet_twisted
hg pull
hg update

=== Version control ===

The source code can is available using [ darcs] version control tool. The darcs repository can be fetched with:

darcs get sipsimpleclient

To obtain the incremental changes after the initial get, go to the sipsimpleclient directory and run:

cd sipsimpleclient
darcs pull

== Documentation ==

Manual installation instructions are available in [source:docs/INSTALL.debian INSTALL.debian], [source:docs/INSTALL.linux INSTALL.linux], [source:docs/INSTALL.osx INSTALL.osx] and [source:docs/INSTALL.maemo INSTALL.maemo] for the corresponding platforms.

== Testing the library ==

SIP SIMPLE client is closely developed together with and tested against the most popular SIP SIMPLE server software available today: [ OpenSIPS], [ OpenXCAP] and [ MSRPRelay]. Included with the library, a set of command line tools are available for setting up audio, Instant Messaging and file transfer sessions, publish and subscribe to presence or other type of events.

* [wiki:sip_register sip_register] - REGISTER a SIP end-point with a SIP Registrar
* [wiki:sip_rtp_audio_session sip_audio_session] - Setup a voice audio session (Voice over IP)
* [wiki:sip_msrp_im_session sip_im_session] - Setup IM session and File transfer using MSRP protocol
* [wiki:sip_message sip_message] - Send/receive text in page mode using SIP MESSAGE method
* [wiki:sip_publish_presence sip_publish_presence] - PUBLISH presence to a SIP Presence Agent
* [wiki:sip_subscribe_presence sip_subscribe_presence] - SUBSCRIBE to presence information
* [wiki:sip_subscribe_winfo sip_subscribe_winfo] - SUBSCRIBE to watcher list on a SIP Presence Agent
* [wiki:sip_subscribe_rls sip_subscribe_rls] - SUBSCRIBE to lists managed by Resource List Server
* [wiki:xcapclient xcapclient] - PUT/GET/DELETE full or partial documents on an XCAP server
* [wiki:xcap_pres_rules xcap_pres_rules] - Manage content of pres-rules XCAP document
* [wiki:xcap_rls_services] - Manage content of RLS services XCAP document

== Supported platforms ==

As a library with a high-level API, the toolkit can be used to add voice, IM and Presence functionality to any Internet device as long as Python/C environment is supported by such platform.

== Normative references ==

Additional to the SIP standards implemented by the underlying [ PJSIP library] and exposed by SIP SIMPLE client in a Python API, this project implements in Python language the following standards:

* XCAP protocol stack and client [ RFC4825]
* XCAP pres-rules [ RFC5025]
* XCAP resource-lists and rls-services [ RFC4826]
* XCAP pidf-manipulation [ RFC4827]
* MSRP protocol stack and client [ RFC4975]
* MSRP protocol relay extension [ RFC4976]
* MSRP multi-party chat [ draft-ietf-simple-chat-02]
* SIP PUBLISH method [ RFC3903]
* SIP SUBSCRIBE and SIP NOTIFY methods [ RFC3265]
* Rich Presence Information Data model and Format (RPIDF) [ RFC3856], [ RFC3863 ], [ RFC4479]
* XCAP-diff event package [ draft-ietf-simple-xcap-diff-09]
* Watcher Information event package [ RFC3857], [ RFC3858]
* Conference event package [ RFC4575]
* Message Waiting Indication event package [ RFC3842]
* Bonjour multicast DNS [ draft-lee-sip-dns-sd-uri-02]
* Locating SIP services [ RFC3263]

== Support ==

This project is developed and supported by [ AG Projects].

To request support you must open a ticket. To open ticket please [/register Register] first. The source browser and ticketing system are available only for registered users.

If you wish to contribute and become an active developer of this project, send your request by email to